JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.0
[ckeditor.git] / _source / plugins / elementspath / plugin.js
diff --git a/_source/plugins/elementspath/plugin.js b/_source/plugins/elementspath/plugin.js
new file mode 100644 (file)
index 0000000..75fc4ee
--- /dev/null
@@ -0,0 +1,182 @@
+/*\r
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+For licensing, see LICENSE.html or http://ckeditor.com/license\r
+*/\r
+\r
+/**\r
+ * @fileOverview The "elementspath" plugin. It shows all elements in the DOM\r
+ *             parent tree relative to the current selection in the editing area.\r
+ */\r
+\r
+(function()\r
+{\r
+       var commands =\r
+       {\r
+               toolbarFocus :\r
+               {\r
+                       exec : function( editor )\r
+                       {\r
+                               var idBase = editor._.elementsPath.idBase;\r
+                               var element = CKEDITOR.document.getById( idBase + '0' );\r
+\r
+                               if ( element )\r
+                                       element.focus();\r
+                       }\r
+               }\r
+       };\r
+\r
+       var emptyHtml = '<span class="cke_empty">&nbsp;</span>';\r
+\r
+       CKEDITOR.plugins.add( 'elementspath',\r
+       {\r
+               requires : [ 'selection' ],\r
+\r
+               init : function( editor )\r
+               {\r
+                       var spaceId = 'cke_path_' + editor.name;\r
+                       var spaceElement;\r
+                       var getSpaceElement = function()\r
+                       {\r
+                               if ( !spaceElement )\r
+                                       spaceElement = CKEDITOR.document.getById( spaceId );\r
+                               return spaceElement;\r
+                       };\r
+\r
+                       var idBase = 'cke_elementspath_' + CKEDITOR.tools.getNextNumber() + '_';\r
+\r
+                       editor._.elementsPath = { idBase : idBase };\r
+\r
+                       editor.on( 'themeSpace', function( event )\r
+                               {\r
+                                       if ( event.data.space == 'bottom' )\r
+                                               event.data.html += '<div id="' + spaceId + '" class="cke_path">' + emptyHtml + '</div>';\r
+                               });\r
+\r
+                       editor.on( 'selectionChange', function( ev )\r
+                               {\r
+                                       var env = CKEDITOR.env;\r
+\r
+                                       var selection = ev.data.selection;\r
+\r
+                                       var element = selection.getStartElement(),\r
+                                               html = [],\r
+                                               elementsList = this._.elementsPath.list = [];\r
+\r
+                                       while ( element )\r
+                                       {\r
+                                               var index = elementsList.push( element ) - 1;\r
+                                               var name;\r
+                                               if ( element.getAttribute( '_cke_real_element_type' ) )\r
+                                                       name = element.getAttribute( '_cke_real_element_type' );\r
+                                               else\r
+                                                       name = element.getName();\r
+\r
+                                               // Use this variable to add conditional stuff to the\r
+                                               // HTML (because we are doing it in reverse order... unshift).\r
+                                               var extra = '';\r
+\r
+                                               // Some browsers don't cancel key events in the keydown but in the\r
+                                               // keypress.\r
+                                               // TODO: Check if really needed for Gecko+Mac.\r
+                                               if ( env.opera || ( env.gecko && env.mac ) )\r
+                                                       extra += ' onkeypress="return false;"';\r
+\r
+                                               // With Firefox, we need to force the button to redraw, otherwise it\r
+                                               // will remain in the focus state.\r
+                                               if ( env.gecko )\r
+                                                       extra += ' onblur="this.style.cssText = this.style.cssText;"';\r
+\r
+                                               html.unshift(\r
+                                                       '<a' +\r
+                                                               ' id="', idBase, index, '"' +\r
+                                                               ' href="javascript:void(\'', name, '\')"' +\r
+                                                               ' tabindex="-1"' +\r
+                                                               ' title="', editor.lang.elementsPath.eleTitle.replace( /%1/, name ), '"' +\r
+                                                               ( ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 ) ?\r
+                                                               ' onfocus="event.preventBubble();"' : '' ) +\r
+                                                               ' hidefocus="true" ' +\r
+                                                               ' onkeydown="return CKEDITOR._.elementsPath.keydown(\'', this.name, '\',', index, ', event);"' +\r
+                                                               extra ,\r
+                                                               ' onclick="return CKEDITOR._.elementsPath.click(\'', this.name, '\',', index, ');">',\r
+                                                                       name,\r
+                                                       '</a>' );\r
+\r
+                                               if ( name == 'body' )\r
+                                                       break;\r
+\r
+                                               element = element.getParent();\r
+                                       }\r
+\r
+                                       getSpaceElement().setHtml( html.join('') + emptyHtml );\r
+                               });\r
+\r
+                       editor.on( 'contentDomUnload', function()\r
+                               {\r
+                                       getSpaceElement().setHtml( emptyHtml );\r
+                               });\r
+\r
+                       editor.addCommand( 'elementsPathFocus', commands.toolbarFocus );\r
+               }\r
+       });\r
+})();\r
+\r
+/**\r
+ * Handles the click on an element in the element path.\r
+ * @private\r
+ */\r
+CKEDITOR._.elementsPath =\r
+{\r
+       click : function( instanceName, elementIndex )\r
+       {\r
+               var editor = CKEDITOR.instances[ instanceName ];\r
+               editor.focus();\r
+\r
+               var element = editor._.elementsPath.list[ elementIndex ];\r
+               editor.getSelection().selectElement( element );\r
+\r
+               return false;\r
+       },\r
+\r
+       keydown : function( instanceName, elementIndex, ev )\r
+       {\r
+               var instance = CKEDITOR.ui.button._.instances[ elementIndex ];\r
+               var editor = CKEDITOR.instances[ instanceName ];\r
+               var idBase = editor._.elementsPath.idBase;\r
+\r
+               var element;\r
+\r
+               ev = new CKEDITOR.dom.event( ev );\r
+\r
+               switch ( ev.getKeystroke() )\r
+               {\r
+                       case 37 :                                       // LEFT-ARROW\r
+                       case 9 :                                        // TAB\r
+                               element = CKEDITOR.document.getById( idBase + ( elementIndex + 1 ) );\r
+                               if ( !element )\r
+                                       element = CKEDITOR.document.getById( idBase + '0' );\r
+                               element.focus();\r
+                               return false;\r
+\r
+                       case 39 :                                       // RIGHT-ARROW\r
+                       case CKEDITOR.SHIFT + 9 :       // SHIFT + TAB\r
+                               element = CKEDITOR.document.getById( idBase + ( elementIndex - 1 ) );\r
+                               if ( !element )\r
+                                       element = CKEDITOR.document.getById( idBase + ( editor._.elementsPath.list.length - 1 ) );\r
+                               element.focus();\r
+                               return false;\r
+\r
+                       case 27 :                                       // ESC\r
+                               editor.focus();\r
+                               return false;\r
+\r
+                       case 13 :                                       // ENTER        // Opera\r
+                       case 32 :                                       // SPACE\r
+                               this.click( instanceName, elementIndex );\r
+                               return false;\r
+\r
+                       //default :\r
+                       //      alert( ev.getKeystroke() );\r
+               }\r
+               return true;\r
+       }\r
+};\r