JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.5.3
[ckeditor.git] / _source / core / dom / node.js
1 /*\r
2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license\r
4 */\r
5 \r
6 /**\r
7  * @fileOverview Defines the {@link CKEDITOR.dom.node} class, which is the base\r
8  *              class for classes that represent DOM nodes.\r
9  */\r
10 \r
11 /**\r
12  * Base class for classes representing DOM nodes. This constructor may return\r
13  * and instance of classes that inherits this class, like\r
14  * {@link CKEDITOR.dom.element} or {@link CKEDITOR.dom.text}.\r
15  * @augments CKEDITOR.dom.domObject\r
16  * @param {Object} domNode A native DOM node.\r
17  * @constructor\r
18  * @see CKEDITOR.dom.element\r
19  * @see CKEDITOR.dom.text\r
20  * @example\r
21  */\r
22 CKEDITOR.dom.node = function( domNode )\r
23 {\r
24         if ( domNode )\r
25         {\r
26                 switch ( domNode.nodeType )\r
27                 {\r
28                         // Safari don't consider document as element node type. (#3389)\r
29                         case CKEDITOR.NODE_DOCUMENT :\r
30                                 return new CKEDITOR.dom.document( domNode );\r
31 \r
32                         case CKEDITOR.NODE_ELEMENT :\r
33                                 return new CKEDITOR.dom.element( domNode );\r
34 \r
35                         case CKEDITOR.NODE_TEXT :\r
36                                 return new CKEDITOR.dom.text( domNode );\r
37                 }\r
38 \r
39                 // Call the base constructor.\r
40                 CKEDITOR.dom.domObject.call( this, domNode );\r
41         }\r
42 \r
43         return this;\r
44 };\r
45 \r
46 CKEDITOR.dom.node.prototype = new CKEDITOR.dom.domObject();\r
47 \r
48 /**\r
49  * Element node type.\r
50  * @constant\r
51  * @example\r
52  */\r
53 CKEDITOR.NODE_ELEMENT = 1;\r
54 \r
55 /**\r
56  * Document node type.\r
57  * @constant\r
58  * @example\r
59  */\r
60 CKEDITOR.NODE_DOCUMENT = 9;\r
61 \r
62 /**\r
63  * Text node type.\r
64  * @constant\r
65  * @example\r
66  */\r
67 CKEDITOR.NODE_TEXT = 3;\r
68 \r
69 /**\r
70  * Comment node type.\r
71  * @constant\r
72  * @example\r
73  */\r
74 CKEDITOR.NODE_COMMENT = 8;\r
75 \r
76 CKEDITOR.NODE_DOCUMENT_FRAGMENT = 11;\r
77 \r
78 CKEDITOR.POSITION_IDENTICAL = 0;\r
79 CKEDITOR.POSITION_DISCONNECTED = 1;\r
80 CKEDITOR.POSITION_FOLLOWING = 2;\r
81 CKEDITOR.POSITION_PRECEDING = 4;\r
82 CKEDITOR.POSITION_IS_CONTAINED = 8;\r
83 CKEDITOR.POSITION_CONTAINS = 16;\r
84 \r
85 CKEDITOR.tools.extend( CKEDITOR.dom.node.prototype,\r
86         /** @lends CKEDITOR.dom.node.prototype */\r
87         {\r
88                 /**\r
89                  * Makes this node child of another element.\r
90                  * @param {CKEDITOR.dom.element} element The target element to which append\r
91                  *              this node.\r
92                  * @returns {CKEDITOR.dom.element} The target element.\r
93                  * @example\r
94                  * var p = new CKEDITOR.dom.element( 'p' );\r
95                  * var strong = new CKEDITOR.dom.element( 'strong' );\r
96                  * strong.appendTo( p );\r
97                  *\r
98                  * // result: "<p><strong></strong></p>"\r
99                  */\r
100                 appendTo : function( element, toStart )\r
101                 {\r
102                         element.append( this, toStart );\r
103                         return element;\r
104                 },\r
105 \r
106                 clone : function( includeChildren, cloneId )\r
107                 {\r
108                         var $clone = this.$.cloneNode( includeChildren );\r
109 \r
110                         var removeIds = function( node )\r
111                         {\r
112                                 if ( node.nodeType != CKEDITOR.NODE_ELEMENT )\r
113                                         return;\r
114 \r
115                                 if ( !cloneId )\r
116                                         node.removeAttribute( 'id', false );\r
117                                 node.removeAttribute( 'data-cke-expando', false );\r
118 \r
119                                 if ( includeChildren )\r
120                                 {\r
121                                         var childs = node.childNodes;\r
122                                         for ( var i=0; i < childs.length; i++ )\r
123                                                 removeIds( childs[ i ] );\r
124                                 }\r
125                         };\r
126 \r
127                         // The "id" attribute should never be cloned to avoid duplication.\r
128                         removeIds( $clone );\r
129 \r
130                         return new CKEDITOR.dom.node( $clone );\r
131                 },\r
132 \r
133                 hasPrevious : function()\r
134                 {\r
135                         return !!this.$.previousSibling;\r
136                 },\r
137 \r
138                 hasNext : function()\r
139                 {\r
140                         return !!this.$.nextSibling;\r
141                 },\r
142 \r
143                 /**\r
144                  * Inserts this element after a node.\r
145                  * @param {CKEDITOR.dom.node} node The that will preceed this element.\r
146                  * @returns {CKEDITOR.dom.node} The node preceeding this one after\r
147                  *              insertion.\r
148                  * @example\r
149                  * var em = new CKEDITOR.dom.element( 'em' );\r
150                  * var strong = new CKEDITOR.dom.element( 'strong' );\r
151                  * strong.insertAfter( em );\r
152                  *\r
153                  * // result: "&lt;em&gt;&lt;/em&gt;&lt;strong&gt;&lt;/strong&gt;"\r
154                  */\r
155                 insertAfter : function( node )\r
156                 {\r
157                         node.$.parentNode.insertBefore( this.$, node.$.nextSibling );\r
158                         return node;\r
159                 },\r
160 \r
161                 /**\r
162                  * Inserts this element before a node.\r
163                  * @param {CKEDITOR.dom.node} node The that will be after this element.\r
164                  * @returns {CKEDITOR.dom.node} The node being inserted.\r
165                  * @example\r
166                  * var em = new CKEDITOR.dom.element( 'em' );\r
167                  * var strong = new CKEDITOR.dom.element( 'strong' );\r
168                  * strong.insertBefore( em );\r
169                  *\r
170                  * // result: "&lt;strong&gt;&lt;/strong&gt;&lt;em&gt;&lt;/em&gt;"\r
171                  */\r
172                 insertBefore : function( node )\r
173                 {\r
174                         node.$.parentNode.insertBefore( this.$, node.$ );\r
175                         return node;\r
176                 },\r
177 \r
178                 insertBeforeMe : function( node )\r
179                 {\r
180                         this.$.parentNode.insertBefore( node.$, this.$ );\r
181                         return node;\r
182                 },\r
183 \r
184                 /**\r
185                  * Retrieves a uniquely identifiable tree address for this node.\r
186                  * The tree address returns is an array of integers, with each integer\r
187                  * indicating a child index of a DOM node, starting from\r
188                  * document.documentElement.\r
189                  *\r
190                  * For example, assuming <body> is the second child from <html> (<head>\r
191                  * being the first), and we'd like to address the third child under the\r
192                  * fourth child of body, the tree address returned would be:\r
193                  * [1, 3, 2]\r
194                  *\r
195                  * The tree address cannot be used for finding back the DOM tree node once\r
196                  * the DOM tree structure has been modified.\r
197                  */\r
198                 getAddress : function( normalized )\r
199                 {\r
200                         var address = [];\r
201                         var $documentElement = this.getDocument().$.documentElement;\r
202                         var node = this.$;\r
203 \r
204                         while ( node && node != $documentElement )\r
205                         {\r
206                                 var parentNode = node.parentNode;\r
207 \r
208                                 if ( parentNode )\r
209                                 {\r
210                                         // Get the node index. For performance, call getIndex\r
211                                         // directly, instead of creating a new node object.\r
212                                         address.unshift( this.getIndex.call( { $ : node }, normalized ) );\r
213                                 }\r
214 \r
215                                 node = parentNode;\r
216                         }\r
217 \r
218                         return address;\r
219                 },\r
220 \r
221                 /**\r
222                  * Gets the document containing this element.\r
223                  * @returns {CKEDITOR.dom.document} The document.\r
224                  * @example\r
225                  * var element = CKEDITOR.document.getById( 'example' );\r
226                  * alert( <b>element.getDocument().equals( CKEDITOR.document )</b> );  // "true"\r
227                  */\r
228                 getDocument : function()\r
229                 {\r
230                         return new CKEDITOR.dom.document( this.$.ownerDocument || this.$.parentNode.ownerDocument );\r
231                 },\r
232 \r
233                 getIndex : function( normalized )\r
234                 {\r
235                         // Attention: getAddress depends on this.$\r
236 \r
237                         var current = this.$,\r
238                                 index = 0;\r
239 \r
240                         while ( ( current = current.previousSibling ) )\r
241                         {\r
242                                 // When normalizing, do not count it if this is an\r
243                                 // empty text node or if it's a text node following another one.\r
244                                 if ( normalized && current.nodeType == 3 &&\r
245                                          ( !current.nodeValue.length ||\r
246                                            ( current.previousSibling && current.previousSibling.nodeType == 3 ) ) )\r
247                                 {\r
248                                         continue;\r
249                                 }\r
250 \r
251                                 index++;\r
252                         }\r
253 \r
254                         return index;\r
255                 },\r
256 \r
257                 getNextSourceNode : function( startFromSibling, nodeType, guard )\r
258                 {\r
259                         // If "guard" is a node, transform it in a function.\r
260                         if ( guard && !guard.call )\r
261                         {\r
262                                 var guardNode = guard;\r
263                                 guard = function( node )\r
264                                 {\r
265                                         return !node.equals( guardNode );\r
266                                 };\r
267                         }\r
268 \r
269                         var node = ( !startFromSibling && this.getFirst && this.getFirst() ),\r
270                                 parent;\r
271 \r
272                         // Guarding when we're skipping the current element( no children or 'startFromSibling' ).\r
273                         // send the 'moving out' signal even we don't actually dive into.\r
274                         if ( !node )\r
275                         {\r
276                                 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )\r
277                                         return null;\r
278                                 node = this.getNext();\r
279                         }\r
280 \r
281                         while ( !node && ( parent = ( parent || this ).getParent() ) )\r
282                         {\r
283                                 // The guard check sends the "true" paramenter to indicate that\r
284                                 // we are moving "out" of the element.\r
285                                 if ( guard && guard( parent, true ) === false )\r
286                                         return null;\r
287 \r
288                                 node = parent.getNext();\r
289                         }\r
290 \r
291                         if ( !node )\r
292                                 return null;\r
293 \r
294                         if ( guard && guard( node ) === false )\r
295                                 return null;\r
296 \r
297                         if ( nodeType && nodeType != node.type )\r
298                                 return node.getNextSourceNode( false, nodeType, guard );\r
299 \r
300                         return node;\r
301                 },\r
302 \r
303                 getPreviousSourceNode : function( startFromSibling, nodeType, guard )\r
304                 {\r
305                         if ( guard && !guard.call )\r
306                         {\r
307                                 var guardNode = guard;\r
308                                 guard = function( node )\r
309                                 {\r
310                                         return !node.equals( guardNode );\r
311                                 };\r
312                         }\r
313 \r
314                         var node = ( !startFromSibling && this.getLast && this.getLast() ),\r
315                                 parent;\r
316 \r
317                         // Guarding when we're skipping the current element( no children or 'startFromSibling' ).\r
318                         // send the 'moving out' signal even we don't actually dive into.\r
319                         if ( !node )\r
320                         {\r
321                                 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )\r
322                                         return null;\r
323                                 node = this.getPrevious();\r
324                         }\r
325 \r
326                         while ( !node && ( parent = ( parent || this ).getParent() ) )\r
327                         {\r
328                                 // The guard check sends the "true" paramenter to indicate that\r
329                                 // we are moving "out" of the element.\r
330                                 if ( guard && guard( parent, true ) === false )\r
331                                         return null;\r
332 \r
333                                 node = parent.getPrevious();\r
334                         }\r
335 \r
336                         if ( !node )\r
337                                 return null;\r
338 \r
339                         if ( guard && guard( node ) === false )\r
340                                 return null;\r
341 \r
342                         if ( nodeType && node.type != nodeType )\r
343                                 return node.getPreviousSourceNode( false, nodeType, guard );\r
344 \r
345                         return node;\r
346                 },\r
347 \r
348                 getPrevious : function( evaluator )\r
349                 {\r
350                         var previous = this.$, retval;\r
351                         do\r
352                         {\r
353                                 previous = previous.previousSibling;\r
354                                 retval = previous && new CKEDITOR.dom.node( previous );\r
355                         }\r
356                         while ( retval && evaluator && !evaluator( retval ) )\r
357                         return retval;\r
358                 },\r
359 \r
360                 /**\r
361                  * Gets the node that follows this element in its parent's child list.\r
362                  * @param {Function} evaluator Filtering the result node.\r
363                  * @returns {CKEDITOR.dom.node} The next node or null if not available.\r
364                  * @example\r
365                  * var element = CKEDITOR.dom.element.createFromHtml( '&lt;div&gt;&lt;b&gt;Example&lt;/b&gt; &lt;i&gt;next&lt;/i&gt;&lt;/div&gt;' );\r
366                  * var first = <b>element.getFirst().getNext()</b>;\r
367                  * alert( first.getName() );  // "i"\r
368                  */\r
369                 getNext : function( evaluator )\r
370                 {\r
371                         var next = this.$, retval;\r
372                         do\r
373                         {\r
374                                 next = next.nextSibling;\r
375                                 retval = next && new CKEDITOR.dom.node( next );\r
376                         }\r
377                         while ( retval && evaluator && !evaluator( retval ) )\r
378                         return retval;\r
379                 },\r
380 \r
381                 /**\r
382                  * Gets the parent element for this node.\r
383                  * @returns {CKEDITOR.dom.element} The parent element.\r
384                  * @example\r
385                  * var node = editor.document.getBody().getFirst();\r
386                  * var parent = node.<b>getParent()</b>;\r
387                  * alert( node.getName() );  // "body"\r
388                  */\r
389                 getParent : function()\r
390                 {\r
391                         var parent = this.$.parentNode;\r
392                         return ( parent && parent.nodeType == 1 ) ? new CKEDITOR.dom.node( parent ) : null;\r
393                 },\r
394 \r
395                 getParents : function( closerFirst )\r
396                 {\r
397                         var node = this;\r
398                         var parents = [];\r
399 \r
400                         do\r
401                         {\r
402                                 parents[  closerFirst ? 'push' : 'unshift' ]( node );\r
403                         }\r
404                         while ( ( node = node.getParent() ) )\r
405 \r
406                         return parents;\r
407                 },\r
408 \r
409                 getCommonAncestor : function( node )\r
410                 {\r
411                         if ( node.equals( this ) )\r
412                                 return this;\r
413 \r
414                         if ( node.contains && node.contains( this ) )\r
415                                 return node;\r
416 \r
417                         var start = this.contains ? this : this.getParent();\r
418 \r
419                         do\r
420                         {\r
421                                 if ( start.contains( node ) )\r
422                                         return start;\r
423                         }\r
424                         while ( ( start = start.getParent() ) );\r
425 \r
426                         return null;\r
427                 },\r
428 \r
429                 getPosition : function( otherNode )\r
430                 {\r
431                         var $ = this.$;\r
432                         var $other = otherNode.$;\r
433 \r
434                         if ( $.compareDocumentPosition )\r
435                                 return $.compareDocumentPosition( $other );\r
436 \r
437                         // IE and Safari have no support for compareDocumentPosition.\r
438 \r
439                         if ( $ == $other )\r
440                                 return CKEDITOR.POSITION_IDENTICAL;\r
441 \r
442                         // Only element nodes support contains and sourceIndex.\r
443                         if ( this.type == CKEDITOR.NODE_ELEMENT && otherNode.type == CKEDITOR.NODE_ELEMENT )\r
444                         {\r
445                                 if ( $.contains )\r
446                                 {\r
447                                         if ( $.contains( $other ) )\r
448                                                 return CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING;\r
449 \r
450                                         if ( $other.contains( $ ) )\r
451                                                 return CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;\r
452                                 }\r
453 \r
454                                 if ( 'sourceIndex' in $ )\r
455                                 {\r
456                                         return ( $.sourceIndex < 0 || $other.sourceIndex < 0 ) ? CKEDITOR.POSITION_DISCONNECTED :\r
457                                                 ( $.sourceIndex < $other.sourceIndex ) ? CKEDITOR.POSITION_PRECEDING :\r
458                                                 CKEDITOR.POSITION_FOLLOWING;\r
459                                 }\r
460                         }\r
461 \r
462                         // For nodes that don't support compareDocumentPosition, contains\r
463                         // or sourceIndex, their "address" is compared.\r
464 \r
465                         var addressOfThis = this.getAddress(),\r
466                                 addressOfOther = otherNode.getAddress(),\r
467                                 minLevel = Math.min( addressOfThis.length, addressOfOther.length );\r
468 \r
469                                 // Determinate preceed/follow relationship.\r
470                                 for ( var i = 0 ; i <= minLevel - 1 ; i++ )\r
471                                 {\r
472                                         if ( addressOfThis[ i ] != addressOfOther[ i ] )\r
473                                         {\r
474                                                 if ( i < minLevel )\r
475                                                 {\r
476                                                         return addressOfThis[ i ] < addressOfOther[ i ] ?\r
477                                                             CKEDITOR.POSITION_PRECEDING : CKEDITOR.POSITION_FOLLOWING;\r
478                                                 }\r
479                                                 break;\r
480                                         }\r
481                                 }\r
482 \r
483                                 // Determinate contains/contained relationship.\r
484                                 return ( addressOfThis.length < addressOfOther.length ) ?\r
485                                                         CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING :\r
486                                                         CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;\r
487                 },\r
488 \r
489                 /**\r
490                  * Gets the closest ancestor node of this node, specified by its node name.\r
491                  * @param {String} name The node name of the ancestor node to search.\r
492                  * @param {Boolean} [includeSelf] Whether to include the current\r
493                  * node in the search.\r
494                  * @returns {CKEDITOR.dom.node} The located ancestor node or null if not found.\r
495                  * @example\r
496                  * // Suppose we have the following HTML:\r
497                  * // &lt;div id="outer"&gt;&lt;div id="inner"&gt;&lt;p&gt;&lt;b&gt;Some text&lt;/b&gt;&lt;/p&gt;&lt;/div&gt;&lt;/div&gt;\r
498                  * // If node == &lt;b&gt;\r
499                  * ascendant = node.getAscendant( 'div' );      // ascendant == &lt;div id="inner"&gt\r
500                  * ascendant = node.getAscendant( 'b' );        // ascendant == null\r
501                  * ascendant = node.getAscendant( 'b', true );  // ascendant == &lt;b&gt;\r
502                  */\r
503                 getAscendant : function( name, includeSelf )\r
504                 {\r
505                         var $ = this.$;\r
506 \r
507                         if ( !includeSelf )\r
508                                 $ = $.parentNode;\r
509 \r
510                         while ( $ )\r
511                         {\r
512                                 if ( $.nodeName && $.nodeName.toLowerCase() == name )\r
513                                         return new CKEDITOR.dom.node( $ );\r
514 \r
515                                 $ = $.parentNode;\r
516                         }\r
517                         return null;\r
518                 },\r
519 \r
520                 hasAscendant : function( name, includeSelf )\r
521                 {\r
522                         var $ = this.$;\r
523 \r
524                         if ( !includeSelf )\r
525                                 $ = $.parentNode;\r
526 \r
527                         while ( $ )\r
528                         {\r
529                                 if ( $.nodeName && $.nodeName.toLowerCase() == name )\r
530                                         return true;\r
531 \r
532                                 $ = $.parentNode;\r
533                         }\r
534                         return false;\r
535                 },\r
536 \r
537                 move : function( target, toStart )\r
538                 {\r
539                         target.append( this.remove(), toStart );\r
540                 },\r
541 \r
542                 /**\r
543                  * Removes this node from the document DOM.\r
544                  * @param {Boolean} [preserveChildren] Indicates that the children\r
545                  *              elements must remain in the document, removing only the outer\r
546                  *              tags.\r
547                  * @example\r
548                  * var element = CKEDITOR.dom.element.getById( 'MyElement' );\r
549                  * <b>element.remove()</b>;\r
550                  */\r
551                 remove : function( preserveChildren )\r
552                 {\r
553                         var $ = this.$;\r
554                         var parent = $.parentNode;\r
555 \r
556                         if ( parent )\r
557                         {\r
558                                 if ( preserveChildren )\r
559                                 {\r
560                                         // Move all children before the node.\r
561                                         for ( var child ; ( child = $.firstChild ) ; )\r
562                                         {\r
563                                                 parent.insertBefore( $.removeChild( child ), $ );\r
564                                         }\r
565                                 }\r
566 \r
567                                 parent.removeChild( $ );\r
568                         }\r
569 \r
570                         return this;\r
571                 },\r
572 \r
573                 replace : function( nodeToReplace )\r
574                 {\r
575                         this.insertBefore( nodeToReplace );\r
576                         nodeToReplace.remove();\r
577                 },\r
578 \r
579                 trim : function()\r
580                 {\r
581                         this.ltrim();\r
582                         this.rtrim();\r
583                 },\r
584 \r
585                 ltrim : function()\r
586                 {\r
587                         var child;\r
588                         while ( this.getFirst && ( child = this.getFirst() ) )\r
589                         {\r
590                                 if ( child.type == CKEDITOR.NODE_TEXT )\r
591                                 {\r
592                                         var trimmed = CKEDITOR.tools.ltrim( child.getText() ),\r
593                                                 originalLength = child.getLength();\r
594 \r
595                                         if ( !trimmed )\r
596                                         {\r
597                                                 child.remove();\r
598                                                 continue;\r
599                                         }\r
600                                         else if ( trimmed.length < originalLength )\r
601                                         {\r
602                                                 child.split( originalLength - trimmed.length );\r
603 \r
604                                                 // IE BUG: child.remove() may raise JavaScript errors here. (#81)\r
605                                                 this.$.removeChild( this.$.firstChild );\r
606                                         }\r
607                                 }\r
608                                 break;\r
609                         }\r
610                 },\r
611 \r
612                 rtrim : function()\r
613                 {\r
614                         var child;\r
615                         while ( this.getLast && ( child = this.getLast() ) )\r
616                         {\r
617                                 if ( child.type == CKEDITOR.NODE_TEXT )\r
618                                 {\r
619                                         var trimmed = CKEDITOR.tools.rtrim( child.getText() ),\r
620                                                 originalLength = child.getLength();\r
621 \r
622                                         if ( !trimmed )\r
623                                         {\r
624                                                 child.remove();\r
625                                                 continue;\r
626                                         }\r
627                                         else if ( trimmed.length < originalLength )\r
628                                         {\r
629                                                 child.split( trimmed.length );\r
630 \r
631                                                 // IE BUG: child.getNext().remove() may raise JavaScript errors here.\r
632                                                 // (#81)\r
633                                                 this.$.lastChild.parentNode.removeChild( this.$.lastChild );\r
634                                         }\r
635                                 }\r
636                                 break;\r
637                         }\r
638 \r
639                         if ( !CKEDITOR.env.ie && !CKEDITOR.env.opera )\r
640                         {\r
641                                 child = this.$.lastChild;\r
642 \r
643                                 if ( child && child.type == 1 && child.nodeName.toLowerCase() == 'br' )\r
644                                 {\r
645                                         // Use "eChildNode.parentNode" instead of "node" to avoid IE bug (#324).\r
646                                         child.parentNode.removeChild( child ) ;\r
647                                 }\r
648                         }\r
649                 },\r
650 \r
651                 /**\r
652                  * Checks is this node is read-only (should not be changed). It\r
653                  * additionaly returns the element, if any, which defines the read-only\r
654                  * state of this node. It may be the node itself or any of its parent\r
655                  * nodes.\r
656                  * @returns {CKEDITOR.dom.element|Boolean} An element containing\r
657                  *              read-only attributes or "false" if none is found.\r
658                  * @since 3.5\r
659                  * @example\r
660                  * // For the following HTML:\r
661                  * // &lt;div contenteditable="false"&gt;Some &lt;b&gt;text&lt;/b&gt;&lt;/div&gt;\r
662                  *\r
663                  * // If "ele" is the above &lt;div&gt;\r
664                  * ele.isReadOnly();  // the &lt;div&gt; element\r
665                  *\r
666                  * // If "ele" is the above &lt;b&gt;\r
667                  * ele.isReadOnly();  // the &lt;div&gt; element\r
668                  */\r
669                 isReadOnly : function()\r
670                 {\r
671                         var current = this;\r
672                         while( current )\r
673                         {\r
674                                 if ( current.type == CKEDITOR.NODE_ELEMENT )\r
675                                 {\r
676                                         if ( current.is( 'body' ) || !!current.data( 'cke-editable' ) )\r
677                                                 break;\r
678 \r
679                                         if ( current.getAttribute( 'contentEditable' ) == 'false' )\r
680                                                 return current;\r
681                                         else if ( current.getAttribute( 'contentEditable' ) == 'true' )\r
682                                                 break;\r
683                                 }\r
684                                 current = current.getParent();\r
685                         }\r
686 \r
687                         return false;\r
688                 }\r
689         }\r
690 );\r