httemplate/elements/fckeditor/editor/plugins/placeholder/fckplugin.js

   1 /*\r
   2  * FCKeditor - The text editor for Internet - http://www.fckeditor.net\r
   3  * Copyright (C) 2003-2010 Frederico Caldeira Knabben\r
   4  *\r
   5  * == BEGIN LICENSE ==\r
   6  *\r
   7  * Licensed under the terms of any of the following licenses at your\r
   8  * choice:\r
   9  *\r
  10  *  - GNU General Public License Version 2 or later (the "GPL")\r
  11  *    http://www.gnu.org/licenses/gpl.html\r
  12  *\r
  13  *  - GNU Lesser General Public License Version 2.1 or later (the "LGPL")\r
  14  *    http://www.gnu.org/licenses/lgpl.html\r
  15  *\r
  16  *  - Mozilla Public License Version 1.1 or later (the "MPL")\r
  17  *    http://www.mozilla.org/MPL/MPL-1.1.html\r
  18  *\r
  19  * == END LICENSE ==\r
  20  *\r
  21  * Plugin to insert "Placeholders" in the editor.\r
  22  */\r
  23 \r
  24 // Register the related command.\r
  25 FCKCommands.RegisterCommand( 'Placeholder', new FCKDialogCommand( 'Placeholder', FCKLang.PlaceholderDlgTitle, FCKPlugins.Items['placeholder'].Path + 'fck_placeholder.html', 340, 160 ) ) ;\r
  26 \r
  27 // Create the "Plaholder" toolbar button.\r
  28 var oPlaceholderItem = new FCKToolbarButton( 'Placeholder', FCKLang.PlaceholderBtn ) ;\r
  29 oPlaceholderItem.IconPath = FCKPlugins.Items['placeholder'].Path + 'placeholder.gif' ;\r
  30 \r
  31 FCKToolbarItems.RegisterItem( 'Placeholder', oPlaceholderItem ) ;\r
  32 \r
  33 \r
  34 // The object used for all Placeholder operations.\r
  35 var FCKPlaceholders = new Object() ;\r
  36 \r
  37 // Add a new placeholder at the actual selection.\r
  38 FCKPlaceholders.Add = function( name )\r
  39 {\r
  40         var oSpan = FCK.InsertElement( 'span' ) ;\r
  41         this.SetupSpan( oSpan, name ) ;\r
  42 }\r
  43 \r
  44 FCKPlaceholders.SetupSpan = function( span, name )\r
  45 {\r
  46         span.innerHTML = '[[ ' + name + ' ]]' ;\r
  47 \r
  48         span.style.backgroundColor = '#ffff00' ;\r
  49         span.style.color = '#000000' ;\r
  50 \r
  51         if ( FCKBrowserInfo.IsGecko )\r
  52                 span.style.cursor = 'default' ;\r
  53 \r
  54         span._fckplaceholder = name ;\r
  55         span.contentEditable = false ;\r
  56 \r
  57         // To avoid it to be resized.\r
  58         span.onresizestart = function()\r
  59         {\r
  60                 FCK.EditorWindow.event.returnValue = false ;\r
  61                 return false ;\r
  62         }\r
  63 }\r
  64 \r
  65 // On Gecko we must do this trick so the user select all the SPAN when clicking on it.\r
  66 FCKPlaceholders._SetupClickListener = function()\r
  67 {\r
  68         FCKPlaceholders._ClickListener = function( e )\r
  69         {\r
  70                 if ( e.target.tagName == 'SPAN' && e.target._fckplaceholder )\r
  71                         FCKSelection.SelectNode( e.target ) ;\r
  72         }\r
  73 \r
  74         FCK.EditorDocument.addEventListener( 'click', FCKPlaceholders._ClickListener, true ) ;\r
  75 }\r
  76 \r
  77 // Open the Placeholder dialog on double click.\r
  78 FCKPlaceholders.OnDoubleClick = function( span )\r
  79 {\r
  80         if ( span.tagName == 'SPAN' && span._fckplaceholder )\r
  81                 FCKCommands.GetCommand( 'Placeholder' ).Execute() ;\r
  82 }\r
  83 \r
  84 FCK.RegisterDoubleClickHandler( FCKPlaceholders.OnDoubleClick, 'SPAN' ) ;\r
  85 \r
  86 // Check if a Placholder name is already in use.\r
  87 FCKPlaceholders.Exist = function( name )\r
  88 {\r
  89         var aSpans = FCK.EditorDocument.getElementsByTagName( 'SPAN' ) ;\r
  90 \r
  91         for ( var i = 0 ; i < aSpans.length ; i++ )\r
  92         {\r
  93                 if ( aSpans[i]._fckplaceholder == name )\r
  94                         return true ;\r
  95         }\r
  96 \r
  97         return false ;\r
  98 }\r
  99 \r
 100 if ( FCKBrowserInfo.IsIE )\r
 101 {\r
 102         FCKPlaceholders.Redraw = function()\r
 103         {\r
 104                 if ( FCK.EditMode != FCK_EDITMODE_WYSIWYG )\r
 105                         return ;\r
 106 \r
 107                 var aPlaholders = FCK.EditorDocument.body.innerText.match( /\[\[[^\[\]]+\]\]/g ) ;\r
 108                 if ( !aPlaholders )\r
 109                         return ;\r
 110 \r
 111                 var oRange = FCK.EditorDocument.body.createTextRange() ;\r
 112 \r
 113                 for ( var i = 0 ; i < aPlaholders.length ; i++ )\r
 114                 {\r
 115                         if ( oRange.findText( aPlaholders[i] ) )\r
 116                         {\r
 117                                 var sName = aPlaholders[i].match( /\[\[\s*([^\]]*?)\s*\]\]/ )[1] ;\r
 118                                 oRange.pasteHTML( '<span style="color: #000000; background-color: #ffff00" contenteditable="false" _fckplaceholder="' + sName + '">' + aPlaholders[i] + '</span>' ) ;\r
 119                         }\r
 120                 }\r
 121         }\r
 122 }\r
 123 else\r
 124 {\r
 125         FCKPlaceholders.Redraw = function()\r
 126         {\r
 127                 if ( FCK.EditMode != FCK_EDITMODE_WYSIWYG )\r
 128                         return ;\r
 129 \r
 130                 var oInteractor = FCK.EditorDocument.createTreeWalker( FCK.EditorDocument.body, NodeFilter.SHOW_TEXT, FCKPlaceholders._AcceptNode, true ) ;\r
 131 \r
 132                 var     aNodes = new Array() ;\r
 133 \r
 134                 while ( ( oNode = oInteractor.nextNode() ) )\r
 135                 {\r
 136                         aNodes[ aNodes.length ] = oNode ;\r
 137                 }\r
 138 \r
 139                 for ( var n = 0 ; n < aNodes.length ; n++ )\r
 140                 {\r
 141                         var aPieces = aNodes[n].nodeValue.split( /(\[\[[^\[\]]+\]\])/g ) ;\r
 142 \r
 143                         for ( var i = 0 ; i < aPieces.length ; i++ )\r
 144                         {\r
 145                                 if ( aPieces[i].length > 0 )\r
 146                                 {\r
 147                                         if ( aPieces[i].indexOf( '[[' ) == 0 )\r
 148                                         {\r
 149                                                 var sName = aPieces[i].match( /\[\[\s*([^\]]*?)\s*\]\]/ )[1] ;\r
 150 \r
 151                                                 var oSpan = FCK.EditorDocument.createElement( 'span' ) ;\r
 152                                                 FCKPlaceholders.SetupSpan( oSpan, sName ) ;\r
 153 \r
 154                                                 aNodes[n].parentNode.insertBefore( oSpan, aNodes[n] ) ;\r
 155                                         }\r
 156                                         else\r
 157                                                 aNodes[n].parentNode.insertBefore( FCK.EditorDocument.createTextNode( aPieces[i] ) , aNodes[n] ) ;\r
 158                                 }\r
 159                         }\r
 160 \r
 161                         aNodes[n].parentNode.removeChild( aNodes[n] ) ;\r
 162                 }\r
 163 \r
 164                 FCKPlaceholders._SetupClickListener() ;\r
 165         }\r
 166 \r
 167         FCKPlaceholders._AcceptNode = function( node )\r
 168         {\r
 169                 if ( /\[\[[^\[\]]+\]\]/.test( node.nodeValue ) )\r
 170                         return NodeFilter.FILTER_ACCEPT ;\r
 171                 else\r
 172                         return NodeFilter.FILTER_SKIP ;\r
 173         }\r
 174 }\r
 175 \r
 176 FCK.Events.AttachEvent( 'OnAfterSetHTML', FCKPlaceholders.Redraw ) ;\r
 177 \r
 178 // We must process the SPAN tags to replace then with the real resulting value of the placeholder.\r
 179 FCKXHtml.TagProcessors['span'] = function( node, htmlNode )\r
 180 {\r
 181         if ( htmlNode._fckplaceholder )\r
 182                 node = FCKXHtml.XML.createTextNode( '[[' + htmlNode._fckplaceholder + ']]' ) ;\r
 183         else\r
 184                 FCKXHtml._AppendChildNodes( node, htmlNode, false ) ;\r
 185 \r
 186         return node ;\r
 187 }\r