http://www.mediawiki.org/wiki/Special:Code/MediaWiki/94326
Revision: 94326
Author: inez
Date: 2011-08-12 06:52:59 +0000 (Fri, 12 Aug 2011)
Log Message:
-----------
Rough implementation of new handling for lists - old implementation kept for
now in oldListBlock (a lot of functionality and comments to be moved)
Modified Paths:
--------------
trunk/parsers/wikidom/lib/es/es.ListBlock.js
trunk/parsers/wikidom/lib/es/es.ListBlockItem.js
trunk/parsers/wikidom/lib/es/es.ListBlockList.js
Added Paths:
-----------
trunk/parsers/wikidom/lib/es/oldListBlock/
trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlock.js
trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockItem.js
trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockList.js
Modified: trunk/parsers/wikidom/lib/es/es.ListBlock.js
===================================================================
--- trunk/parsers/wikidom/lib/es/es.ListBlock.js 2011-08-12 06:41:55 UTC
(rev 94325)
+++ trunk/parsers/wikidom/lib/es/es.ListBlock.js 2011-08-12 06:52:59 UTC
(rev 94326)
@@ -1,35 +1,18 @@
-/**
- * Creates a list block.
- *
- * @class
- * @constructor
- * @extends {es.Block}
- * @param list {es.ListBlockList} Root list to initialize with
- * @property list {es.ListBlockList}
- * @property $ {jQuery}
- */
es.ListBlock = function( list ) {
es.Block.call( this );
+
this.list = list || new es.ListBlockList();
+
this.$ = this.list.$
.addClass( 'editSurface-block' )
.data( 'block', this );
- var listBlock = this;
+
+ var listBlock = this;
this.list.on( 'update', function() {
listBlock.emit( 'update' );
} );
};
-/* Static Methods */
-
-/**
- * Creates a new list block object from WikiDom data.
- *
- * @static
- * @method
- * @param wikidomParagraphBlock {Object} WikiDom data to convert from
- * @returns {es.ListBlock} EditSurface list block
- */
es.ListBlock.newFromWikiDomListBlock = function( wikidomListBlock ) {
if ( wikidomListBlock.type !== 'list' ) {
throw 'Invalid block type error. List block expected to be of
type "list".';
@@ -37,398 +20,9 @@
return new es.ListBlock( es.ListBlockList.newFromWikiDomList(
wikidomListBlock ) );
};
-/* Methods */
-
-/**
- * Gets the length of all block content.
- *
- * @method
- * @returns {Integer} Length of content
- */
-es.ListBlock.prototype.getLength = function() {
- // Compensate for n+1 virtual position on the last item's content
- return this.list.getLength() - 1;
-};
-
-/**
- * Inserts content into a block at an offset.
- *
- * @method
- * @param offset {Integer} Position to insert content at
- * @param content {Object} Content to insert
- */
-es.ListBlock.prototype.insertContent = function( offset, content ) {
- var location = this.list.getLocationFromOffset( offset );
- location.item.flow.content.insert( location.offset, content );
-};
-
-/**
- * Deletes content in a block within a range.
- *
- * @method
- * @param range {es.Range} Range of content to remove
- */
-es.ListBlock.prototype.deleteContent = function( range ) {
- range.normalize();
-
- var locationStart = this.list.getLocationFromOffset( range.start ),
- locationEnd = this.list.getLocationFromOffset( range.end );
-
- if ( locationStart.item == locationEnd.item ) {
-
- // delete content within one item
-
- locationStart.item.content.remove(
- new es.Range( locationStart.offset,
locationStart.offset + range.getLength() )
- );
-
- } else {
-
- // delete content across multiple items
-
- // delete selected content in first selected item
- locationStart.item.content.remove(
- new es.Range(
- locationStart.offset,
- locationStart.item.content.getLength()
- )
- );
-
- // grab not selected content from last selected item..
- var toAppend = locationEnd.item.content.getContent(
- new es.Range(
- locationEnd.offset,
- locationEnd.item.content.getLength()
- )
- );
-
- // ..and insert it at the end of first selected item
- locationStart.item.content.insert( locationStart.offset,
toAppend.data );
-
- var toDelete = [],
- toAdopt = [],
- newParents = [],
- toDeleteCollecting = false,
- toAdoptCollecting = false,
- itemLevel,
- toAdoptLevel,
- newParent,
- startItemLevel = locationStart.item.getLevel();
-
- this.traverseItems( function( item, index ) {
- itemLevel = item.getLevel();
-
- if ( toDeleteCollecting === false && toDelete.length
=== 0 ) {
- // collect items from before the selection as
possible parents for items that may need adoption
- // only one item per level
- newParents[ itemLevel ] = {
- item: item,
- child: item.lists[0] ?
item.lists[0].first() : null
- };
- newParents = newParents.slice( 0, itemLevel + 1
);
- }
-
- if ( toDeleteCollecting ) {
- // keep collecting items for deletion
- toDelete.push( item );
- }
-
- if ( item == locationStart.item ) {
- // start collecting items for deletion
- toDeleteCollecting = true;
- }
-
- if ( item == locationEnd.item ) {
- // stop collecting items for deletion
- // start collecting items for adoption
- toDeleteCollecting = false;
- toAdoptCollecting = true;
- return true;
- }
-
- if ( toAdoptCollecting ) {
- // collect items for adoption
- // only those which parents will be removed
- if( toDelete.indexOf ( item.list.item ) !== -1
) {
- toAdopt.push( item );
- }
- }
-
- } );
-
- for ( var i = 0; i < toAdopt.length; i++ ) {
- toAdoptLevel = toAdopt[i].getLevel();
-
- // determine new parent for item to adopt
- if ( newParents[ toAdoptLevel - 1 ] ) {
- newParent = newParents[ toAdoptLevel - 1 ];
- } else {
- newParent = newParents[ newParents.length - 1 ]
- }
-
- if( newParent.child && toAdoptLevel > startItemLevel ) {
- newParent.item.lists[0].insertBefore(
toAdopt[i], newParent.child );
- } else {
- if ( newParent.item.lists[0] ) {
- newParent.item.lists[0].append(
toAdopt[i] );
- } else {
- newParent.item.append(
- new es.ListBlockList(
- toAdopt[i].list.style,
- [ toAdopt[i] ]
- )
- );
- }
- }
- }
-
- for ( var i = 0; i < toDelete.length; i++ ) {
- toDelete[i].list.remove( toDelete[i] );
- }
- }
-};
-
-/**
- * Applies an annotation to a given range.
- *
- * If a range arguments are not provided, all content will be annotated.
- *
- * @method
- * @param method {String} Way to apply annotation ("toggle", "add" or "remove")
- * @param annotation {Object} Annotation to apply
- * @param range {es.Range} Range of content to annotate
- */
-es.ListBlock.prototype.annotateContent = function( method, annotation, range )
{
- range.normalize();
- var locationStart = this.list.getLocationFromOffset( range.start ),
- locationEnd = this.list.getLocationFromOffset( range.end );
-
- if ( locationStart.item == locationEnd.item ) {
- // annotating content within one item
- locationStart.item.content.annotate(
- method,
- annotation,
- new es.Range( locationStart.offset,
locationStart.offset + range.end - range.start )
- );
- } else {
- // annotating content across multiple items
-
- // collect all items to be later annotate - you can not modify
during traversing
- var itemsToAnnotate;
- this.traverseItems( function( item, index ) {
- if ( item == locationEnd.item ) {
- return false;
- }
- if ( $.isArray( itemsToAnnotate ) ) {
- itemsToAnnotate.push( item );
- }
- if ( item == locationStart.item ) {
- itemsToAnnotate = [];
- }
- } );
-
- // annotate content in the first item - from offset to end
- locationStart.item.content.annotate(
- method,
- annotation,
- new es.Range( locationStart.offset,
locationStart.item.content.getLength() )
- );
-
- // annotate content in the last item - from beginning to offset
- locationEnd.item.content.annotate(
- method,
- annotation,
- new es.Range( 0, locationEnd.offset )
- );
-
- // annotate content in all items in between first and last items
- for ( var i = 0; i < itemsToAnnotate.length; i++ ) {
- itemsToAnnotate[i].content.annotate(
- method,
- annotation,
- new es.Range( 0,
itemsToAnnotate[i].content.getLength() )
- );
- }
- }
-};
-
-/**
- * Gets content within a range.
- *
- * @method
- * @param range {es.Range} Range of content to get
- * @returns {es.Content} Content within range
- */
-es.ListBlock.prototype.getContent = function( range ) {
- // TODO: Implement me!
- return new es.Content();
-};
-
-/**
- * Gets content as plain text within a range.
- *
- * @method
- * @param range {Range} Range of text to get
- * @param render {Boolean} If annotations should have any influence on output
- * @returns {String} Text within range
- */
-es.ListBlock.prototype.getText = function( range ) {
- // TODO: Implement me!
- return '';
-};
-
-/**
- * Renders content into a container.
- *
- * @method
- * @param offset {Integer} Offset to render from, if possible
- */
es.ListBlock.prototype.renderContent = function( offset ) {
this.list.renderContent( offset );
};
-/**
- * Gets the offset of a position.
- *
- * @method
- * @param position {es.Position} Position to translate
- * @returns {Integer} Offset nearest to position
- */
-es.ListBlock.prototype.getOffset = function( position ) {
- if ( position.top < 0 ) {
- return 0;
- } else if ( position.top >= this.$.height() ) {
- return this.getLength();
- }
- var blockOffset = this.$.offset();
- position.top += blockOffset.top;
- position.left += blockOffset.left;
- return this.list.getOffsetFromPosition( position );
-};
-
-/**
- * Gets the position of an offset.
- *
- * @method
- * @param offset {Integer} Offset to translate
- * @returns {es.Position} Position of offset
- */
-es.ListBlock.prototype.getPosition = function( offset ) {
- var location = this.list.getLocationFromOffset( offset )
- position = location.item.flow.getPosition( location.offset ),
- blockOffset = this.$.offset(),
- lineOffset = location.item.$content.offset();
-
- position.top += lineOffset.top - blockOffset.top;
- position.left += lineOffset.left - blockOffset.left;
- position.bottom += lineOffset.top - blockOffset.top;
-
- this.traverseItems( function( item ) {
- if ( item === location.item ) {
- return false;
- }
- position.line += item.flow.lines.length;
- } );
- return position;
-};
-
-/**
- * Gets the start and end points of the word closest a given offset.
- *
- * @method
- * @param offset {Integer} Offset to find word nearest to
- * @returns {Object} Range object of boundaries
- */
-es.ListBlock.prototype.getWordBoundaries = function( offset ) {
- var location = this.list.getLocationFromOffset( offset );
- var boundaries = location.item.flow.content.getWordBoundaries(
location.offset );
- boundaries.start += offset - location.offset;
- boundaries.end += offset - location.offset;
- return boundaries;
-};
-
-/**
- * Gets the start and end points of the section closest a given offset.
- *
- * @method
- * @param offset {Integer} Offset to find section nearest to
- * @returns {Object} Range object of boundaries
- */
-es.ListBlock.prototype.getSectionBoundaries = function( offset ) {
- var location = this.list.getLocationFromOffset( offset ),
- start = offset - location.offset;
- return new es.Range( start, start + location.item.content.getLength() );
-};
-
-es.ListBlock.prototype.getLineBoundaries = function( offset ) {
- var location = this.list.getLocationFromOffset( offset ),
- line;
-
- for ( var i = 0; i < location.item.flow.lines.length; i++ ) {
- line = location.item.flow.lines[i];
- if ( location.offset >= line.range.start && location.offset <
line.range.end ) {
- break;
- }
- }
-
- return new es.Range(
- ( offset - location.offset ) + line.range.start,
- ( offset - location.offset ) + ( line.range.end <
location.item.content.getLength() ? line.range.end - 1 : line.range.end )
- );
-};
-
-/**
- * Iteratively execute a callback on each item in the list.
- *
- * Traversal is performed in a depth-first pattern, which is equivilant to a
vertical scan of list
- * items. To stop traversal, return false within the callback function.
- *
- * @method
- * @param callback {Function} Function to execute for each item, accepts an
item and index argument
- * @returns {Boolean} Whether all items were traversed, or traversal was cut
short
- */
-es.ListBlock.prototype.traverseItems = function( callback ) {
- var stack = [{ 'list': this.list, 'index': 0 }],
- list,
- item,
- pop,
- parent,
- index = 0;
- while ( stack.length ) {
- iteration = stack[stack.length - 1];
- pop = true;
- while ( iteration.index < iteration.list.items.length ) {
- item = iteration.list.items[iteration.index++];
- if ( callback( item, index++ ) === false ) {
- return false;
- }
- if ( item.lists.length ) {
- parent = stack.length;
- for ( var i = 0; i < item.lists.length; i++ ) {
- stack.push( { 'list': item.lists[i],
'index': 0, 'parent': parent } );
- }
- pop = false;
- break;
- }
- }
- if ( pop ) {
- if ( iteration.parent ) {
- stack = stack.slice( 0, iteration.parent );
- } else {
- stack.pop();
- }
- }
- }
- return true;
-};
-
-/* Registration */
-
-/**
- * Extend es.Block to support list block creation with es.Block.newFromWikiDom
- */
es.Block.blockConstructors.list = es.ListBlock.newFromWikiDomListBlock;
-
-/* Inheritance */
-
es.extend( es.ListBlock, es.Block );
Modified: trunk/parsers/wikidom/lib/es/es.ListBlockItem.js
===================================================================
--- trunk/parsers/wikidom/lib/es/es.ListBlockItem.js 2011-08-12 06:41:55 UTC
(rev 94325)
+++ trunk/parsers/wikidom/lib/es/es.ListBlockItem.js 2011-08-12 06:52:59 UTC
(rev 94326)
@@ -1,190 +1,19 @@
-/**
- * List item.
- *
- * @class
- * @constructor
- * @extends {es.EventEmitter}
- * @extends {es.Container}
- * @param content {es.Content} Item content
- * @param lists {Array} List of item sub-lists
- * @property content {es.Content} Item content
- * @property lists {Array} List of item sub-lists
- * @property $line {jQuery} Line element
- * @property $content {jQuery} Content element
- * @property flow {es.Flow} Text flow object for content
- */
-es.ListBlockItem = function( content, lists ) {
+es.ListBlockItem = function( content, style, level ) {
es.EventEmitter.call( this );
- es.Container.call( this, 'item', 'lists', lists, 'li' );
-
+
this.content = content || new es.Content();
- this.$content = $( '<div class="editSurface-list-content"></div>' );
- this.$.prepend( this.$content );
- this.flow = new es.Flow( this.$content, this.content );
-
- /*
- this.content = content || new es.Content();
- this.$line = $( '<div class="editSurface-list-line"></div>' );
- this.$content = $( '<div class="editSurface-list-content"></div>' );
- this.$.prepend( this.$line.append( this.$content ) );
- this.flow = new es.Flow( this.$content, this.content );
- */
-
+ this.$ = $( '<div class="editSurface-list-content"></div>' )
+ .addClass( 'editSurface-item-level' + level );
+ this.flow = new es.Flow( this.$, this.content );
+
var listBlockItem = this;
this.flow.on( 'render', function() {
listBlockItem.emit( 'update' );
} );
}
-/* Static Methods */
-
-/**
- * Creates an EditSurface list item object from a WikiDom list item object.
- *
- * @static
- * @method
- * @param wikidomListItem {Object} WikiDom list item
- * @returns {es.ListBlockItem} EditSurface list block item
- */
-es.ListBlockItem.newFromWikiDomListItem = function( wikidomListItem ) {
- // Convert items to es.ListBlockItem objects
- var lists = [];
- if ( wikidomListItem.lists ) {
- for ( var i = 0; i < wikidomListItem.lists.length; i++ ) {
- lists.push( es.ListBlockList.newFromWikiDomList(
wikidomListItem.lists[i] ) );
- }
- }
- return new es.ListBlockItem( es.Content.newFromWikiDomLine(
wikidomListItem.line ), lists );
-};
-
-/* Methods */
-
-/**
- * Gets the index of the item within it's list.
- *
- * TODO: Move to es.Container
- *
- * @method
- * @returns {Integer} Index of item
- */
-es.ListBlockItem.prototype.getIndex = function() {
- return this.list._list.indexOf( this );
-};
-
-/**
- * Gets the length of content in both the line and sub-lists.
- *
- * @method
- * @returns {Integer} Length of content
- */
-es.ListBlockItem.prototype.getLength = function() {
- var length = this.content.getLength() + 1;
- for ( var i = 0; i < this.lists.length; i++ ) {
- length += this.lists[i].getLength();
- }
- return length;
-};
-
-/**
- * Gets a location from an offset.
- *
- * @method
- * @param offset {Integer} Offset to get location for
- * @returns {Object} Location object with item and offset properties, where
offset is local
- * to item.
- */
-es.ListBlockItem.prototype.getLocationFromOffset = function( offset ) {
- var contentLength = this.content.getLength() + 1;
- if ( offset < contentLength ) {
- return {
- 'item': this,
- 'offset': offset
- };
- }
- offset -= contentLength;
- var listOffset = 0,
- listLength;
- for ( var i = 0; i < this.lists.length; i++ ) {
- listLength = this.lists[i].getLength();
- if ( offset >= listOffset && offset < listOffset + listLength )
{
- return this.lists[i].getLocationFromOffset( offset -
listOffset );
- }
- listOffset += listLength;
- }
-};
-
-/**
- * Gets an offset within the item from a position.
- *
- * @method
- * @param position {es.Position} Position to translate
- * @returns {Integer} Offset nearest position
- * @returns {Null} If offset could not be found
- */
-es.ListBlockItem.prototype.getOffsetFromPosition = function( position ) {
- var itemOffset = this.$.offset(),
- itemHeight = this.$.height(),
- offset = null,
- globalOffset = null;
-
- if ( position.top >= itemOffset.top && position.top < itemOffset.top +
itemHeight ) {
- if ( position.top < itemOffset.top + this.$content.height() ) {
- position.top -= itemOffset.top;
- position.left -= itemOffset.left;
- return globalOffset + this.flow.getOffset( position );
- }
-
- for ( var i = 0; i < this.lists.length; i++ ) {
- offset = this.lists[i].getOffsetFromPosition( position
);
- if ( offset != null ) {
- return globalOffset + offset +
this.content.getLength() + 1;
- } else {
- globalOffset += this.lists[i].getLength();
- }
- }
- }
- return null;
-};
-
-/**
- * Gets a depth level for the item in list.
- * Example:
- *
- * # level 0
- * ## level 1
- * # level 0
- * ### level 2
- *
- * @method
- * @returns {Integer} Depth level
- */
-es.ListBlockItem.prototype.getLevel = function( position ) {
- var start = this.list.item,
- level = 0;
-
- while ( start ) {
- start = start.list.item;
- level++;
- }
-
- return level;
-};
-
-/**
- * Renders content and sub-lists.
- *
- * @method
- * @param offset {Integer} Offset to render from if possible
- */
es.ListBlockItem.prototype.renderContent = function( offset ) {
- // TODO: Abstract offset and use it when rendering
this.flow.render();
- for ( var i = 0; i < this.lists.length; i++ ) {
- this.lists[i].renderContent();
- }
};
-/* Inheritance */
-
-es.extend( es.ListBlockItem, es.EventEmitter );
-es.extend( es.ListBlockItem, es.Container );
+es.extend( es.ListBlockItem, es.EventEmitter );
\ No newline at end of file
Modified: trunk/parsers/wikidom/lib/es/es.ListBlockList.js
===================================================================
--- trunk/parsers/wikidom/lib/es/es.ListBlockList.js 2011-08-12 06:41:55 UTC
(rev 94325)
+++ trunk/parsers/wikidom/lib/es/es.ListBlockList.js 2011-08-12 06:52:59 UTC
(rev 94326)
@@ -1,115 +1,38 @@
-/**
- * Number or bullet list.
- *
- * @class
- * @constructor
- * @extends {es.EventEmitter}
- * @extends {es.Container}
- * @param style {String} Style of list, either "number" or "bullet"
- * @param items {Array} List of es.ListBlockItem objects to initialize list
with
- * @property style {String} Style of list
- * @property items {Array} List of es.ListBlockItem objects
- */
-es.ListBlockList = function( style, items ) {
+es.ListBlockList = function( items ) {
es.EventEmitter.call( this );
- es.Container.call( this, 'list', 'items', items, 'ul' );
- this.style = style || 'bullet';
- if ( this.style == 'number' ) {
- this.$.css('list-style', 'decimal');
- }
+ es.Container.call( this, 'list', 'items', items );
};
-/* Static Methods */
-
-/**
- * Creates an EditSurface list object from a WikiDom list object.
- *
- * @static
- * @method
- * @param wikidomListItem {Object} WikiDom list item
- * @returns {es.ListBlockItem} EditSurface list block item
- */
es.ListBlockList.newFromWikiDomList = function( wikidomList ) {
var items = [];
- for ( var i = 0; i < wikidomList.items.length; i++ ) {
- items.push( es.ListBlockItem.newFromWikiDomListItem(
wikidomList.items[i] ) );
- }
- return new es.ListBlockList( wikidomList.style, items );
+ es.ListBlockList.flattenList( wikidomList, items, 0 );
+ return new es.ListBlockList( items );
};
-/* Methods */
-
-/**
- * Gets the length of content in both the line and sub-lists.
- *
- * @method
- * @returns {Integer} Length of content
- */
-es.ListBlockList.prototype.getLength = function() {
- var length = 0;
+es.ListBlockList.prototype.renderContent = function( offset ) {
for ( var i = 0; i < this.items.length; i++ ) {
- length += this.items[i].getLength();
+ this.items[i].renderContent();
}
- return length;
};
-/**
- * Gets a location from an offset.
- *
- * @method
- * @param offset {Integer} Offset to get location for
- * @returns {Object} Location object with item and offset properties, where
offset is local
- * to item.
- */
-es.ListBlockList.prototype.getLocationFromOffset = function( offset ) {
- var itemOffset = 0,
- itemLength;
- for ( var i = 0; i < this.items.length; i++ ) {
- itemLength = this.items[i].getLength();
- if ( offset >= itemOffset && offset < itemOffset + itemLength )
{
- return this.items[i].getLocationFromOffset( offset -
itemOffset );
+es.ListBlockList.flattenList = function( wikidomList, items, level ) {
+ for ( var i = 0; i < wikidomList.items.length; i++ ) {
+ items.push(
+ new es.ListBlockItem(
+ es.Content.newFromWikiDomLine(
wikidomList.items[i].line ),
+ wikidomList.style,
+ level
+ )
+ );
+ if ( wikidomList.items[i].lists ) {
+ level++;
+ for ( var j = 0; j < wikidomList.items[i].lists.length;
j++ ) {
+ es.ListBlockList.flattenList(
wikidomList.items[i].lists[j], items, level );
+ }
+ level--;
}
- itemOffset += itemLength;
}
};
-/**
- * Gets an offset within the list from a position.
- *
- * @method
- * @param position {es.Position} Position to translate
- * @returns {Integer} Offset nearest position
- * @returns {Null} If offset could not be found
- */
-es.ListBlockList.prototype.getOffsetFromPosition = function( position ) {
- var itemOffset = null,
- globalOffset = null;
-
- for ( var i = 0; i < this.items.length; i++ ) {
- itemOffset = this.items[i].getOffsetFromPosition( position );
-
- if ( itemOffset !== null ) {
- return globalOffset + itemOffset;
- } else {
- globalOffset += this.items[i].getLength();
- }
- }
-};
-
-/**
- * Renders items.
- *
- * @method
- * @param offset {Integer} Offset to render from if possible
- */
-es.ListBlockList.prototype.renderContent = function( offset ) {
- // TODO: Abstract offset and use it when rendering
- for ( var i = 0; i < this.items.length; i++ ) {
- this.items[i].renderContent();
- }
-};
-
-/* Inheritance */
-
es.extend( es.ListBlockList, es.EventEmitter );
es.extend( es.ListBlockList, es.Container );
Copied: trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlock.js (from rev
94325, trunk/parsers/wikidom/lib/es/es.ListBlock.js)
===================================================================
--- trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlock.js
(rev 0)
+++ trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlock.js 2011-08-12
06:52:59 UTC (rev 94326)
@@ -0,0 +1,434 @@
+/**
+ * Creates a list block.
+ *
+ * @class
+ * @constructor
+ * @extends {es.Block}
+ * @param list {es.ListBlockList} Root list to initialize with
+ * @property list {es.ListBlockList}
+ * @property $ {jQuery}
+ */
+es.ListBlock = function( list ) {
+ es.Block.call( this );
+ this.list = list || new es.ListBlockList();
+ this.$ = this.list.$
+ .addClass( 'editSurface-block' )
+ .data( 'block', this );
+ var listBlock = this;
+ this.list.on( 'update', function() {
+ listBlock.emit( 'update' );
+ } );
+};
+
+/* Static Methods */
+
+/**
+ * Creates a new list block object from WikiDom data.
+ *
+ * @static
+ * @method
+ * @param wikidomParagraphBlock {Object} WikiDom data to convert from
+ * @returns {es.ListBlock} EditSurface list block
+ */
+es.ListBlock.newFromWikiDomListBlock = function( wikidomListBlock ) {
+ if ( wikidomListBlock.type !== 'list' ) {
+ throw 'Invalid block type error. List block expected to be of
type "list".';
+ }
+ return new es.ListBlock( es.ListBlockList.newFromWikiDomList(
wikidomListBlock ) );
+};
+
+/* Methods */
+
+/**
+ * Gets the length of all block content.
+ *
+ * @method
+ * @returns {Integer} Length of content
+ */
+es.ListBlock.prototype.getLength = function() {
+ // Compensate for n+1 virtual position on the last item's content
+ return this.list.getLength() - 1;
+};
+
+/**
+ * Inserts content into a block at an offset.
+ *
+ * @method
+ * @param offset {Integer} Position to insert content at
+ * @param content {Object} Content to insert
+ */
+es.ListBlock.prototype.insertContent = function( offset, content ) {
+ var location = this.list.getLocationFromOffset( offset );
+ location.item.flow.content.insert( location.offset, content );
+};
+
+/**
+ * Deletes content in a block within a range.
+ *
+ * @method
+ * @param range {es.Range} Range of content to remove
+ */
+es.ListBlock.prototype.deleteContent = function( range ) {
+ range.normalize();
+
+ var locationStart = this.list.getLocationFromOffset( range.start ),
+ locationEnd = this.list.getLocationFromOffset( range.end );
+
+ if ( locationStart.item == locationEnd.item ) {
+
+ // delete content within one item
+
+ locationStart.item.content.remove(
+ new es.Range( locationStart.offset,
locationStart.offset + range.getLength() )
+ );
+
+ } else {
+
+ // delete content across multiple items
+
+ // delete selected content in first selected item
+ locationStart.item.content.remove(
+ new es.Range(
+ locationStart.offset,
+ locationStart.item.content.getLength()
+ )
+ );
+
+ // grab not selected content from last selected item..
+ var toAppend = locationEnd.item.content.getContent(
+ new es.Range(
+ locationEnd.offset,
+ locationEnd.item.content.getLength()
+ )
+ );
+
+ // ..and insert it at the end of first selected item
+ locationStart.item.content.insert( locationStart.offset,
toAppend.data );
+
+ var toDelete = [],
+ toAdopt = [],
+ newParents = [],
+ toDeleteCollecting = false,
+ toAdoptCollecting = false,
+ itemLevel,
+ toAdoptLevel,
+ newParent,
+ startItemLevel = locationStart.item.getLevel();
+
+ this.traverseItems( function( item, index ) {
+ itemLevel = item.getLevel();
+
+ if ( toDeleteCollecting === false && toDelete.length
=== 0 ) {
+ // collect items from before the selection as
possible parents for items that may need adoption
+ // only one item per level
+ newParents[ itemLevel ] = {
+ item: item,
+ child: item.lists[0] ?
item.lists[0].first() : null
+ };
+ newParents = newParents.slice( 0, itemLevel + 1
);
+ }
+
+ if ( toDeleteCollecting ) {
+ // keep collecting items for deletion
+ toDelete.push( item );
+ }
+
+ if ( item == locationStart.item ) {
+ // start collecting items for deletion
+ toDeleteCollecting = true;
+ }
+
+ if ( item == locationEnd.item ) {
+ // stop collecting items for deletion
+ // start collecting items for adoption
+ toDeleteCollecting = false;
+ toAdoptCollecting = true;
+ return true;
+ }
+
+ if ( toAdoptCollecting ) {
+ // collect items for adoption
+ // only those which parents will be removed
+ if( toDelete.indexOf ( item.list.item ) !== -1
) {
+ toAdopt.push( item );
+ }
+ }
+
+ } );
+
+ for ( var i = 0; i < toAdopt.length; i++ ) {
+ toAdoptLevel = toAdopt[i].getLevel();
+
+ // determine new parent for item to adopt
+ if ( newParents[ toAdoptLevel - 1 ] ) {
+ newParent = newParents[ toAdoptLevel - 1 ];
+ } else {
+ newParent = newParents[ newParents.length - 1 ]
+ }
+
+ if( newParent.child && toAdoptLevel > startItemLevel ) {
+ newParent.item.lists[0].insertBefore(
toAdopt[i], newParent.child );
+ } else {
+ if ( newParent.item.lists[0] ) {
+ newParent.item.lists[0].append(
toAdopt[i] );
+ } else {
+ newParent.item.append(
+ new es.ListBlockList(
+ toAdopt[i].list.style,
+ [ toAdopt[i] ]
+ )
+ );
+ }
+ }
+ }
+
+ for ( var i = 0; i < toDelete.length; i++ ) {
+ toDelete[i].list.remove( toDelete[i] );
+ }
+ }
+};
+
+/**
+ * Applies an annotation to a given range.
+ *
+ * If a range arguments are not provided, all content will be annotated.
+ *
+ * @method
+ * @param method {String} Way to apply annotation ("toggle", "add" or "remove")
+ * @param annotation {Object} Annotation to apply
+ * @param range {es.Range} Range of content to annotate
+ */
+es.ListBlock.prototype.annotateContent = function( method, annotation, range )
{
+ range.normalize();
+ var locationStart = this.list.getLocationFromOffset( range.start ),
+ locationEnd = this.list.getLocationFromOffset( range.end );
+
+ if ( locationStart.item == locationEnd.item ) {
+ // annotating content within one item
+ locationStart.item.content.annotate(
+ method,
+ annotation,
+ new es.Range( locationStart.offset,
locationStart.offset + range.end - range.start )
+ );
+ } else {
+ // annotating content across multiple items
+
+ // collect all items to be later annotate - you can not modify
during traversing
+ var itemsToAnnotate;
+ this.traverseItems( function( item, index ) {
+ if ( item == locationEnd.item ) {
+ return false;
+ }
+ if ( $.isArray( itemsToAnnotate ) ) {
+ itemsToAnnotate.push( item );
+ }
+ if ( item == locationStart.item ) {
+ itemsToAnnotate = [];
+ }
+ } );
+
+ // annotate content in the first item - from offset to end
+ locationStart.item.content.annotate(
+ method,
+ annotation,
+ new es.Range( locationStart.offset,
locationStart.item.content.getLength() )
+ );
+
+ // annotate content in the last item - from beginning to offset
+ locationEnd.item.content.annotate(
+ method,
+ annotation,
+ new es.Range( 0, locationEnd.offset )
+ );
+
+ // annotate content in all items in between first and last items
+ for ( var i = 0; i < itemsToAnnotate.length; i++ ) {
+ itemsToAnnotate[i].content.annotate(
+ method,
+ annotation,
+ new es.Range( 0,
itemsToAnnotate[i].content.getLength() )
+ );
+ }
+ }
+};
+
+/**
+ * Gets content within a range.
+ *
+ * @method
+ * @param range {es.Range} Range of content to get
+ * @returns {es.Content} Content within range
+ */
+es.ListBlock.prototype.getContent = function( range ) {
+ // TODO: Implement me!
+ return new es.Content();
+};
+
+/**
+ * Gets content as plain text within a range.
+ *
+ * @method
+ * @param range {Range} Range of text to get
+ * @param render {Boolean} If annotations should have any influence on output
+ * @returns {String} Text within range
+ */
+es.ListBlock.prototype.getText = function( range ) {
+ // TODO: Implement me!
+ return '';
+};
+
+/**
+ * Renders content into a container.
+ *
+ * @method
+ * @param offset {Integer} Offset to render from, if possible
+ */
+es.ListBlock.prototype.renderContent = function( offset ) {
+ this.list.renderContent( offset );
+};
+
+/**
+ * Gets the offset of a position.
+ *
+ * @method
+ * @param position {es.Position} Position to translate
+ * @returns {Integer} Offset nearest to position
+ */
+es.ListBlock.prototype.getOffset = function( position ) {
+ if ( position.top < 0 ) {
+ return 0;
+ } else if ( position.top >= this.$.height() ) {
+ return this.getLength();
+ }
+ var blockOffset = this.$.offset();
+ position.top += blockOffset.top;
+ position.left += blockOffset.left;
+ return this.list.getOffsetFromPosition( position );
+};
+
+/**
+ * Gets the position of an offset.
+ *
+ * @method
+ * @param offset {Integer} Offset to translate
+ * @returns {es.Position} Position of offset
+ */
+es.ListBlock.prototype.getPosition = function( offset ) {
+ var location = this.list.getLocationFromOffset( offset )
+ position = location.item.flow.getPosition( location.offset ),
+ blockOffset = this.$.offset(),
+ lineOffset = location.item.$content.offset();
+
+ position.top += lineOffset.top - blockOffset.top;
+ position.left += lineOffset.left - blockOffset.left;
+ position.bottom += lineOffset.top - blockOffset.top;
+
+ this.traverseItems( function( item ) {
+ if ( item === location.item ) {
+ return false;
+ }
+ position.line += item.flow.lines.length;
+ } );
+ return position;
+};
+
+/**
+ * Gets the start and end points of the word closest a given offset.
+ *
+ * @method
+ * @param offset {Integer} Offset to find word nearest to
+ * @returns {Object} Range object of boundaries
+ */
+es.ListBlock.prototype.getWordBoundaries = function( offset ) {
+ var location = this.list.getLocationFromOffset( offset );
+ var boundaries = location.item.flow.content.getWordBoundaries(
location.offset );
+ boundaries.start += offset - location.offset;
+ boundaries.end += offset - location.offset;
+ return boundaries;
+};
+
+/**
+ * Gets the start and end points of the section closest a given offset.
+ *
+ * @method
+ * @param offset {Integer} Offset to find section nearest to
+ * @returns {Object} Range object of boundaries
+ */
+es.ListBlock.prototype.getSectionBoundaries = function( offset ) {
+ var location = this.list.getLocationFromOffset( offset ),
+ start = offset - location.offset;
+ return new es.Range( start, start + location.item.content.getLength() );
+};
+
+es.ListBlock.prototype.getLineBoundaries = function( offset ) {
+ var location = this.list.getLocationFromOffset( offset ),
+ line;
+
+ for ( var i = 0; i < location.item.flow.lines.length; i++ ) {
+ line = location.item.flow.lines[i];
+ if ( location.offset >= line.range.start && location.offset <
line.range.end ) {
+ break;
+ }
+ }
+
+ return new es.Range(
+ ( offset - location.offset ) + line.range.start,
+ ( offset - location.offset ) + ( line.range.end <
location.item.content.getLength() ? line.range.end - 1 : line.range.end )
+ );
+};
+
+/**
+ * Iteratively execute a callback on each item in the list.
+ *
+ * Traversal is performed in a depth-first pattern, which is equivilant to a
vertical scan of list
+ * items. To stop traversal, return false within the callback function.
+ *
+ * @method
+ * @param callback {Function} Function to execute for each item, accepts an
item and index argument
+ * @returns {Boolean} Whether all items were traversed, or traversal was cut
short
+ */
+es.ListBlock.prototype.traverseItems = function( callback ) {
+ var stack = [{ 'list': this.list, 'index': 0 }],
+ list,
+ item,
+ pop,
+ parent,
+ index = 0;
+ while ( stack.length ) {
+ iteration = stack[stack.length - 1];
+ pop = true;
+ while ( iteration.index < iteration.list.items.length ) {
+ item = iteration.list.items[iteration.index++];
+ if ( callback( item, index++ ) === false ) {
+ return false;
+ }
+ if ( item.lists.length ) {
+ parent = stack.length;
+ for ( var i = 0; i < item.lists.length; i++ ) {
+ stack.push( { 'list': item.lists[i],
'index': 0, 'parent': parent } );
+ }
+ pop = false;
+ break;
+ }
+ }
+ if ( pop ) {
+ if ( iteration.parent ) {
+ stack = stack.slice( 0, iteration.parent );
+ } else {
+ stack.pop();
+ }
+ }
+ }
+ return true;
+};
+
+/* Registration */
+
+/**
+ * Extend es.Block to support list block creation with es.Block.newFromWikiDom
+ */
+es.Block.blockConstructors.list = es.ListBlock.newFromWikiDomListBlock;
+
+/* Inheritance */
+
+es.extend( es.ListBlock, es.Block );
Property changes on: trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlock.js
___________________________________________________________________
Added: svn:eol-style
+ native
Copied: trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockItem.js (from rev
94325, trunk/parsers/wikidom/lib/es/es.ListBlockItem.js)
===================================================================
--- trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockItem.js
(rev 0)
+++ trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockItem.js
2011-08-12 06:52:59 UTC (rev 94326)
@@ -0,0 +1,190 @@
+/**
+ * List item.
+ *
+ * @class
+ * @constructor
+ * @extends {es.EventEmitter}
+ * @extends {es.Container}
+ * @param content {es.Content} Item content
+ * @param lists {Array} List of item sub-lists
+ * @property content {es.Content} Item content
+ * @property lists {Array} List of item sub-lists
+ * @property $line {jQuery} Line element
+ * @property $content {jQuery} Content element
+ * @property flow {es.Flow} Text flow object for content
+ */
+es.ListBlockItem = function( content, lists ) {
+ es.EventEmitter.call( this );
+ es.Container.call( this, 'item', 'lists', lists, 'li' );
+
+ this.content = content || new es.Content();
+ this.$content = $( '<div class="editSurface-list-content"></div>' );
+ this.$.prepend( this.$content );
+ this.flow = new es.Flow( this.$content, this.content );
+
+ /*
+ this.content = content || new es.Content();
+ this.$line = $( '<div class="editSurface-list-line"></div>' );
+ this.$content = $( '<div class="editSurface-list-content"></div>' );
+ this.$.prepend( this.$line.append( this.$content ) );
+ this.flow = new es.Flow( this.$content, this.content );
+ */
+
+ var listBlockItem = this;
+ this.flow.on( 'render', function() {
+ listBlockItem.emit( 'update' );
+ } );
+}
+
+/* Static Methods */
+
+/**
+ * Creates an EditSurface list item object from a WikiDom list item object.
+ *
+ * @static
+ * @method
+ * @param wikidomListItem {Object} WikiDom list item
+ * @returns {es.ListBlockItem} EditSurface list block item
+ */
+es.ListBlockItem.newFromWikiDomListItem = function( wikidomListItem ) {
+ // Convert items to es.ListBlockItem objects
+ var lists = [];
+ if ( wikidomListItem.lists ) {
+ for ( var i = 0; i < wikidomListItem.lists.length; i++ ) {
+ lists.push( es.ListBlockList.newFromWikiDomList(
wikidomListItem.lists[i] ) );
+ }
+ }
+ return new es.ListBlockItem( es.Content.newFromWikiDomLine(
wikidomListItem.line ), lists );
+};
+
+/* Methods */
+
+/**
+ * Gets the index of the item within it's list.
+ *
+ * TODO: Move to es.Container
+ *
+ * @method
+ * @returns {Integer} Index of item
+ */
+es.ListBlockItem.prototype.getIndex = function() {
+ return this.list._list.indexOf( this );
+};
+
+/**
+ * Gets the length of content in both the line and sub-lists.
+ *
+ * @method
+ * @returns {Integer} Length of content
+ */
+es.ListBlockItem.prototype.getLength = function() {
+ var length = this.content.getLength() + 1;
+ for ( var i = 0; i < this.lists.length; i++ ) {
+ length += this.lists[i].getLength();
+ }
+ return length;
+};
+
+/**
+ * Gets a location from an offset.
+ *
+ * @method
+ * @param offset {Integer} Offset to get location for
+ * @returns {Object} Location object with item and offset properties, where
offset is local
+ * to item.
+ */
+es.ListBlockItem.prototype.getLocationFromOffset = function( offset ) {
+ var contentLength = this.content.getLength() + 1;
+ if ( offset < contentLength ) {
+ return {
+ 'item': this,
+ 'offset': offset
+ };
+ }
+ offset -= contentLength;
+ var listOffset = 0,
+ listLength;
+ for ( var i = 0; i < this.lists.length; i++ ) {
+ listLength = this.lists[i].getLength();
+ if ( offset >= listOffset && offset < listOffset + listLength )
{
+ return this.lists[i].getLocationFromOffset( offset -
listOffset );
+ }
+ listOffset += listLength;
+ }
+};
+
+/**
+ * Gets an offset within the item from a position.
+ *
+ * @method
+ * @param position {es.Position} Position to translate
+ * @returns {Integer} Offset nearest position
+ * @returns {Null} If offset could not be found
+ */
+es.ListBlockItem.prototype.getOffsetFromPosition = function( position ) {
+ var itemOffset = this.$.offset(),
+ itemHeight = this.$.height(),
+ offset = null,
+ globalOffset = null;
+
+ if ( position.top >= itemOffset.top && position.top < itemOffset.top +
itemHeight ) {
+ if ( position.top < itemOffset.top + this.$content.height() ) {
+ position.top -= itemOffset.top;
+ position.left -= itemOffset.left;
+ return globalOffset + this.flow.getOffset( position );
+ }
+
+ for ( var i = 0; i < this.lists.length; i++ ) {
+ offset = this.lists[i].getOffsetFromPosition( position
);
+ if ( offset != null ) {
+ return globalOffset + offset +
this.content.getLength() + 1;
+ } else {
+ globalOffset += this.lists[i].getLength();
+ }
+ }
+ }
+ return null;
+};
+
+/**
+ * Gets a depth level for the item in list.
+ * Example:
+ *
+ * # level 0
+ * ## level 1
+ * # level 0
+ * ### level 2
+ *
+ * @method
+ * @returns {Integer} Depth level
+ */
+es.ListBlockItem.prototype.getLevel = function( position ) {
+ var start = this.list.item,
+ level = 0;
+
+ while ( start ) {
+ start = start.list.item;
+ level++;
+ }
+
+ return level;
+};
+
+/**
+ * Renders content and sub-lists.
+ *
+ * @method
+ * @param offset {Integer} Offset to render from if possible
+ */
+es.ListBlockItem.prototype.renderContent = function( offset ) {
+ // TODO: Abstract offset and use it when rendering
+ this.flow.render();
+ for ( var i = 0; i < this.lists.length; i++ ) {
+ this.lists[i].renderContent();
+ }
+};
+
+/* Inheritance */
+
+es.extend( es.ListBlockItem, es.EventEmitter );
+es.extend( es.ListBlockItem, es.Container );
Property changes on:
trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockItem.js
___________________________________________________________________
Added: svn:eol-style
+ native
Copied: trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockList.js (from rev
94325, trunk/parsers/wikidom/lib/es/es.ListBlockList.js)
===================================================================
--- trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockList.js
(rev 0)
+++ trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockList.js
2011-08-12 06:52:59 UTC (rev 94326)
@@ -0,0 +1,115 @@
+/**
+ * Number or bullet list.
+ *
+ * @class
+ * @constructor
+ * @extends {es.EventEmitter}
+ * @extends {es.Container}
+ * @param style {String} Style of list, either "number" or "bullet"
+ * @param items {Array} List of es.ListBlockItem objects to initialize list
with
+ * @property style {String} Style of list
+ * @property items {Array} List of es.ListBlockItem objects
+ */
+es.ListBlockList = function( style, items ) {
+ es.EventEmitter.call( this );
+ es.Container.call( this, 'list', 'items', items, 'ul' );
+ this.style = style || 'bullet';
+ if ( this.style == 'number' ) {
+ this.$.css('list-style', 'decimal');
+ }
+};
+
+/* Static Methods */
+
+/**
+ * Creates an EditSurface list object from a WikiDom list object.
+ *
+ * @static
+ * @method
+ * @param wikidomListItem {Object} WikiDom list item
+ * @returns {es.ListBlockItem} EditSurface list block item
+ */
+es.ListBlockList.newFromWikiDomList = function( wikidomList ) {
+ var items = [];
+ for ( var i = 0; i < wikidomList.items.length; i++ ) {
+ items.push( es.ListBlockItem.newFromWikiDomListItem(
wikidomList.items[i] ) );
+ }
+ return new es.ListBlockList( wikidomList.style, items );
+};
+
+/* Methods */
+
+/**
+ * Gets the length of content in both the line and sub-lists.
+ *
+ * @method
+ * @returns {Integer} Length of content
+ */
+es.ListBlockList.prototype.getLength = function() {
+ var length = 0;
+ for ( var i = 0; i < this.items.length; i++ ) {
+ length += this.items[i].getLength();
+ }
+ return length;
+};
+
+/**
+ * Gets a location from an offset.
+ *
+ * @method
+ * @param offset {Integer} Offset to get location for
+ * @returns {Object} Location object with item and offset properties, where
offset is local
+ * to item.
+ */
+es.ListBlockList.prototype.getLocationFromOffset = function( offset ) {
+ var itemOffset = 0,
+ itemLength;
+ for ( var i = 0; i < this.items.length; i++ ) {
+ itemLength = this.items[i].getLength();
+ if ( offset >= itemOffset && offset < itemOffset + itemLength )
{
+ return this.items[i].getLocationFromOffset( offset -
itemOffset );
+ }
+ itemOffset += itemLength;
+ }
+};
+
+/**
+ * Gets an offset within the list from a position.
+ *
+ * @method
+ * @param position {es.Position} Position to translate
+ * @returns {Integer} Offset nearest position
+ * @returns {Null} If offset could not be found
+ */
+es.ListBlockList.prototype.getOffsetFromPosition = function( position ) {
+ var itemOffset = null,
+ globalOffset = null;
+
+ for ( var i = 0; i < this.items.length; i++ ) {
+ itemOffset = this.items[i].getOffsetFromPosition( position );
+
+ if ( itemOffset !== null ) {
+ return globalOffset + itemOffset;
+ } else {
+ globalOffset += this.items[i].getLength();
+ }
+ }
+};
+
+/**
+ * Renders items.
+ *
+ * @method
+ * @param offset {Integer} Offset to render from if possible
+ */
+es.ListBlockList.prototype.renderContent = function( offset ) {
+ // TODO: Abstract offset and use it when rendering
+ for ( var i = 0; i < this.items.length; i++ ) {
+ this.items[i].renderContent();
+ }
+};
+
+/* Inheritance */
+
+es.extend( es.ListBlockList, es.EventEmitter );
+es.extend( es.ListBlockList, es.Container );
Property changes on:
trunk/parsers/wikidom/lib/es/oldListBlock/es.ListBlockList.js
___________________________________________________________________
Added: svn:eol-style
+ native
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
