JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.0
[ckeditor.git] / _source / plugins / tab / plugin.js
diff --git a/_source/plugins/tab/plugin.js b/_source/plugins/tab/plugin.js
new file mode 100644 (file)
index 0000000..55c210a
--- /dev/null
@@ -0,0 +1,266 @@
+/*\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
+(function()\r
+{\r
+       var blurCommand =\r
+               {\r
+                       exec : function( editor )\r
+                       {\r
+                               editor.container.focusNext( true );\r
+                       }\r
+               };\r
+\r
+       var blurBackCommand =\r
+               {\r
+                       exec : function( editor )\r
+                       {\r
+                               editor.container.focusPrevious( true );\r
+                       }\r
+               };\r
+\r
+       CKEDITOR.plugins.add( 'tab',\r
+       {\r
+               requires : [ 'keystrokes' ],\r
+\r
+               init : function( editor )\r
+               {\r
+                       // Register the keystrokes.\r
+                       var keystrokes = editor.keystrokeHandler.keystrokes;\r
+                       keystrokes[ 9 /* TAB */ ] = 'tab';\r
+                       keystrokes[ CKEDITOR.SHIFT + 9 /* TAB */ ] = 'shiftTab';\r
+\r
+                       var tabSpaces = editor.config.tabSpaces,\r
+                               tabText = '';\r
+\r
+                       while ( tabSpaces-- )\r
+                               tabText += '\xa0';\r
+\r
+                       // Register the "tab" and "shiftTab" commands.\r
+                       editor.addCommand( 'tab',\r
+                               {\r
+                                       exec : function( editor )\r
+                                       {\r
+                                               // Fire the "tab" event, making it possible to\r
+                                               // customize the TAB key behavior on specific cases.\r
+                                               if ( !editor.fire( 'tab' ) )\r
+                                               {\r
+                                                       if ( tabText.length > 0 )\r
+                                                               editor.insertHtml( tabText );\r
+                                                       else\r
+                                                       {\r
+                                                               // All browsers jump to the next field on TAB,\r
+                                                               // except Safari, so we have to do that manually\r
+                                                               // here.\r
+                                                               /// https://bugs.webkit.org/show_bug.cgi?id=20597\r
+                                                               return editor.execCommand( 'blur' );\r
+                                                       }\r
+                                               }\r
+\r
+                                               return true;\r
+                                       }\r
+                               });\r
+\r
+                       editor.addCommand( 'shiftTab',\r
+                               {\r
+                                       exec : function( editor )\r
+                                       {\r
+                                               // Fire the "tab" event, making it possible to\r
+                                               // customize the TAB key behavior on specific cases.\r
+                                               if ( !editor.fire( 'shiftTab' ) )\r
+                                                       return editor.execCommand( 'blurBack' );\r
+\r
+                                               return true;\r
+                                       }\r
+                               });\r
+\r
+                       editor.addCommand( 'blur', blurCommand );\r
+                       editor.addCommand( 'blurBack', blurBackCommand );\r
+               }\r
+       });\r
+})();\r
+\r
+/**\r
+ * Moves the UI focus to the element following this element in the tabindex\r
+ * order.\r
+ * @example\r
+ * var element = CKEDITOR.document.getById( 'example' );\r
+ * element.focusNext();\r
+ */\r
+CKEDITOR.dom.element.prototype.focusNext = function( ignoreChildren )\r
+{\r
+       var $ = this.$,\r
+               curTabIndex = this.getTabIndex(),\r
+               passedCurrent, enteredCurrent,\r
+               elected, electedTabIndex,\r
+               element, elementTabIndex;\r
+\r
+       if ( curTabIndex <= 0 )\r
+       {\r
+               // If this element has tabindex <= 0 then we must simply look for any\r
+               // element following it containing tabindex=0.\r
+\r
+               element = this.getNextSourceNode( ignoreChildren, CKEDITOR.NODE_ELEMENT );\r
+\r
+               while( element )\r
+               {\r
+                       if ( element.isVisible() && element.getTabIndex() === 0 )\r
+                       {\r
+                               elected = element;\r
+                               break;\r
+                       }\r
+\r
+                       element = element.getNextSourceNode( false, CKEDITOR.NODE_ELEMENT );\r
+               }\r
+       }\r
+       else\r
+       {\r
+               // If this element has tabindex > 0 then we must look for:\r
+               //              1. An element following this element with the same tabindex.\r
+               //              2. The first element in source other with the lowest tabindex\r
+               //                 that is higher than this element tabindex.\r
+               //              3. The first element with tabindex=0.\r
+\r
+               element = this.getDocument().getBody().getFirst();\r
+\r
+               while( ( element = element.getNextSourceNode( false, CKEDITOR.NODE_ELEMENT ) ) )\r
+               {\r
+                       if ( !passedCurrent )\r
+                       {\r
+                               if ( !enteredCurrent && element.equals( this ) )\r
+                               {\r
+                                       enteredCurrent = true;\r
+\r
+                                       // Ignore this element, if required.\r
+                                       if ( ignoreChildren )\r
+                                       {\r
+                                               if ( !( element = element.getNextSourceNode( true, CKEDITOR.NODE_ELEMENT ) ) )\r
+                                                       break;\r
+                                               passedCurrent = 1;\r
+                                       }\r
+                               }\r
+                               else if ( enteredCurrent && !this.contains( element ) )\r
+                                       passedCurrent = 1;\r
+                       }\r
+\r
+                       if ( !element.isVisible() || ( elementTabIndex = element.getTabIndex() ) < 0 )\r
+                               continue;\r
+\r
+                       if ( passedCurrent && elementTabIndex == curTabIndex )\r
+                       {\r
+                               elected = element;\r
+                               break;\r
+                       }\r
+\r
+                       if ( elementTabIndex > curTabIndex && ( !elected || !electedTabIndex || elementTabIndex < electedTabIndex ) )\r
+                       {\r
+                               elected = element;\r
+                               electedTabIndex = elementTabIndex;\r
+                       }\r
+                       else if ( !elected && elementTabIndex === 0 )\r
+                       {\r
+                               elected = element;\r
+                               electedTabIndex = elementTabIndex;\r
+                       }\r
+               }\r
+       }\r
+\r
+       if ( elected )\r
+               elected.focus();\r
+};\r
+\r
+/**\r
+ * Moves the UI focus to the element before this element in the tabindex order.\r
+ * @example\r
+ * var element = CKEDITOR.document.getById( 'example' );\r
+ * element.focusPrevious();\r
+ */\r
+CKEDITOR.dom.element.prototype.focusPrevious = function( ignoreChildren )\r
+{\r
+       var $ = this.$,\r
+               curTabIndex = this.getTabIndex(),\r
+               passedCurrent, enteredCurrent,\r
+               elected,\r
+               electedTabIndex = 0,\r
+               elementTabIndex;\r
+\r
+       var element = this.getDocument().getBody().getLast();\r
+\r
+       while( ( element = element.getPreviousSourceNode( false, CKEDITOR.NODE_ELEMENT ) ) )\r
+       {\r
+               if ( !passedCurrent )\r
+               {\r
+                       if ( !enteredCurrent && element.equals( this ) )\r
+                       {\r
+                               enteredCurrent = true;\r
+\r
+                               // Ignore this element, if required.\r
+                               if ( ignoreChildren )\r
+                               {\r
+                                       if ( !( element = element.getPreviousSourceNode( true, CKEDITOR.NODE_ELEMENT ) ) )\r
+                                               break;\r
+                                       passedCurrent = 1;\r
+                               }\r
+                       }\r
+                       else if ( enteredCurrent && !this.contains( element ) )\r
+                               passedCurrent = 1;\r
+               }\r
+\r
+               if ( !element.isVisible() || ( elementTabIndex = element.getTabIndex() ) < 0 )\r
+                       continue;\r
+\r
+               if ( curTabIndex <= 0 )\r
+               {\r
+                       // If this element has tabindex <= 0 then we must look for:\r
+                       //              1. An element before this one containing tabindex=0.\r
+                       //              2. The last element with the highest tabindex.\r
+\r
+                       if ( passedCurrent && elementTabIndex === 0 )\r
+                       {\r
+                               elected = element;\r
+                               break;\r
+                       }\r
+\r
+                       if ( elementTabIndex > electedTabIndex )\r
+                       {\r
+                               elected = element;\r
+                               electedTabIndex = elementTabIndex;\r
+                       }\r
+               }\r
+               else\r
+               {\r
+                       // If this element has tabindex > 0 we must look for:\r
+                       //              1. An element preceeding this one, with the same tabindex.\r
+                       //              2. The last element in source other with the highest tabindex\r
+                       //                 that is lower than this element tabindex.\r
+\r
+                       if ( passedCurrent && elementTabIndex == curTabIndex )\r
+                       {\r
+                               elected = element;\r
+                               break;\r
+                       }\r
+\r
+                       if ( elementTabIndex < curTabIndex && ( !elected || elementTabIndex > electedTabIndex ) )\r
+                       {\r
+                               elected = element;\r
+                               electedTabIndex = elementTabIndex;\r
+                       }\r
+               }\r
+       }\r
+\r
+       if ( elected )\r
+               elected.focus();\r
+};\r
+\r
+/**\r
+ * Intructs the editor to add a number of spaces (&amp;nbsp;) to the text when\r
+ * hitting the TAB key. If set to zero, the TAB key will be used to move the\r
+ * cursor focus to the next element in the page, out of the editor focus.\r
+ * @type Number\r
+ * @default 0\r
+ * @example\r
+ * config.tabSpaces = 4;\r
+ */\r
+CKEDITOR.config.tabSpaces = 0 ;\r