_source/plugins/floatpanel/plugin.js

   1 /*\r
   2 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
   3 For licensing, see LICENSE.html or http://ckeditor.com/license\r
   4 */\r
   5 \r
   6 CKEDITOR.plugins.add( 'floatpanel',\r
   7 {\r
   8         requires : [ 'panel' ]\r
   9 });\r
  10 \r
  11 (function()\r
  12 {\r
  13         var panels = {};\r
  14         var isShowing = false;\r
  15 \r
  16         function getPanel( editor, doc, parentElement, definition, level )\r
  17         {\r
  18                 // Generates the panel key: docId-eleId-skinName-langDir[-uiColor][-CSSs][-level]\r
  19                 var key =\r
  20                         doc.getUniqueId() +\r
  21                         '-' + parentElement.getUniqueId() +\r
  22                         '-' + editor.skinName +\r
  23                         '-' + editor.lang.dir +\r
  24                         ( ( editor.uiColor && ( '-' + editor.uiColor ) ) || '' ) +\r
  25                         ( ( definition.css && ( '-' + definition.css ) ) || '' ) +\r
  26                         ( ( level && ( '-' + level ) ) || '' );\r
  27 \r
  28                 var panel = panels[ key ];\r
  29 \r
  30                 if ( !panel )\r
  31                 {\r
  32                         panel = panels[ key ] = new CKEDITOR.ui.panel( doc, definition );\r
  33                         panel.element = parentElement.append( CKEDITOR.dom.element.createFromHtml( panel.renderHtml( editor ), doc ) );\r
  34 \r
  35                         panel.element.setStyles(\r
  36                                 {\r
  37                                         display : 'none',\r
  38                                         position : 'absolute'\r
  39                                 });\r
  40                 }\r
  41 \r
  42                 return panel;\r
  43         }\r
  44 \r
  45         CKEDITOR.ui.floatPanel = CKEDITOR.tools.createClass(\r
  46         {\r
  47                 $ : function( editor, parentElement, definition, level )\r
  48                 {\r
  49                         definition.forceIFrame = true;\r
  50 \r
  51                         var doc = parentElement.getDocument(),\r
  52                                 panel = getPanel( editor, doc, parentElement, definition, level || 0 ),\r
  53                                 element = panel.element,\r
  54                                 iframe = element.getFirst().getFirst();\r
  55 \r
  56                         this.element = element;\r
  57 \r
  58                         this._ =\r
  59                         {\r
  60                                 // The panel that will be floating.\r
  61                                 panel : panel,\r
  62                                 parentElement : parentElement,\r
  63                                 definition : definition,\r
  64                                 document : doc,\r
  65                                 iframe : iframe,\r
  66                                 children : [],\r
  67                                 dir : editor.lang.dir\r
  68                         };\r
  69                 },\r
  70 \r
  71                 proto :\r
  72                 {\r
  73                         addBlock : function( name, block )\r
  74                         {\r
  75                                 return this._.panel.addBlock( name, block );\r
  76                         },\r
  77 \r
  78                         addListBlock : function( name, multiSelect )\r
  79                         {\r
  80                                 return this._.panel.addListBlock( name, multiSelect );\r
  81                         },\r
  82 \r
  83                         getBlock : function( name )\r
  84                         {\r
  85                                 return this._.panel.getBlock( name );\r
  86                         },\r
  87 \r
  88                         /*\r
  89                                 corner (LTR):\r
  90                                         1 = top-left\r
  91                                         2 = top-right\r
  92                                         3 = bottom-right\r
  93                                         4 = bottom-left\r
  94 \r
  95                                 corner (RTL):\r
  96                                         1 = top-right\r
  97                                         2 = top-left\r
  98                                         3 = bottom-left\r
  99                                         4 = bottom-right\r
 100                          */\r
 101                         showBlock : function( name, offsetParent, corner, offsetX, offsetY )\r
 102                         {\r
 103                                 var panel = this._.panel,\r
 104                                         block = panel.showBlock( name );\r
 105 \r
 106                                 this.allowBlur( false );\r
 107                                 isShowing = true;\r
 108 \r
 109                                 var element = this.element,\r
 110                                         iframe = this._.iframe,\r
 111                                         definition = this._.definition,\r
 112                                         position = offsetParent.getDocumentPosition( element.getDocument() ),\r
 113                                         rtl = this._.dir == 'rtl';\r
 114 \r
 115                                 var left        = position.x + ( offsetX || 0 ),\r
 116                                         top             = position.y + ( offsetY || 0 );\r
 117 \r
 118                                 // Floating panels are off by (-1px, 0px) in RTL mode. (#3438)\r
 119                                 if ( rtl && ( corner == 1 || corner == 4 ) )\r
 120                                         left += offsetParent.$.offsetWidth;\r
 121                                 else if ( !rtl && ( corner == 2 || corner == 3 ) )\r
 122                                         left += offsetParent.$.offsetWidth - 1;\r
 123 \r
 124                                 if ( corner == 3 || corner == 4 )\r
 125                                         top += offsetParent.$.offsetHeight - 1;\r
 126 \r
 127                                 // Memorize offsetParent by it's ID.\r
 128                                 this._.panel._.offsetParentId = offsetParent.getId();\r
 129 \r
 130                                 element.setStyles(\r
 131                                         {\r
 132                                                 top : top + 'px',\r
 133                                                 left : '-3000px',\r
 134                                                 opacity : '0',  // FF3 is ignoring "visibility"\r
 135                                                 display : ''\r
 136                                         });\r
 137 \r
 138                                 // Configure the IFrame blur event. Do that only once.\r
 139                                 if ( !this._.blurSet )\r
 140                                 {\r
 141                                         // Non IE prefer the event into a window object.\r
 142                                         var focused = CKEDITOR.env.ie ? iframe : new CKEDITOR.dom.window( iframe.$.contentWindow );\r
 143 \r
 144                                         // With addEventListener compatible browsers, we must\r
 145                                         // useCapture when registering the focus/blur events to\r
 146                                         // guarantee they will be firing in all situations. (#3068, #3222 )\r
 147                                         CKEDITOR.event.useCapture = true;\r
 148 \r
 149                                         focused.on( 'blur', function( ev )\r
 150                                                 {\r
 151                                                         if ( !this.allowBlur() )\r
 152                                                                 return;\r
 153 \r
 154                                                         // As we are using capture to register the listener,\r
 155                                                         // the blur event may get fired even when focusing\r
 156                                                         // inside the window itself, so we must ensure the\r
 157                                                         // target is out of it.\r
 158                                                         var target = ev.data.getTarget(),\r
 159                                                                 targetWindow = target.getWindow && target.getWindow();\r
 160 \r
 161                                                         if ( targetWindow && targetWindow.equals( focused ) )\r
 162                                                                 return;\r
 163 \r
 164                                                         if ( this.visible && !this._.activeChild && !isShowing )\r
 165                                                                 this.hide();\r
 166                                                 },\r
 167                                                 this );\r
 168 \r
 169                                         focused.on( 'focus', function()\r
 170                                                 {\r
 171                                                         this._.focused = true;\r
 172                                                         this.hideChild();\r
 173                                                         this.allowBlur( true );\r
 174                                                 },\r
 175                                                 this );\r
 176 \r
 177                                         CKEDITOR.event.useCapture = false;\r
 178 \r
 179                                         this._.blurSet = 1;\r
 180                                 }\r
 181 \r
 182                                 panel.onEscape = CKEDITOR.tools.bind( function()\r
 183                                         {\r
 184                                                 this.onEscape && this.onEscape();\r
 185                                         },\r
 186                                         this );\r
 187 \r
 188                                 CKEDITOR.tools.setTimeout( function()\r
 189                                         {\r
 190                                                 if ( rtl )\r
 191                                                         left -= element.$.offsetWidth;\r
 192 \r
 193                                                 var panelLoad = CKEDITOR.tools.bind( function ()\r
 194                                                 {\r
 195                                                         if ( block.autoSize )\r
 196                                                         {\r
 197                                                                 var target = element.getFirst();\r
 198                                                                 var height = block.element.$.scrollHeight;\r
 199 \r
 200                                                                 // Account for extra height needed due to IE quirks box model bug:\r
 201                                                                 // http://en.wikipedia.org/wiki/Internet_Explorer_box_model_bug\r
 202                                                                 // (#3426)\r
 203                                                                 if ( CKEDITOR.env.ie && CKEDITOR.env.quirks && height > 0 )\r
 204                                                                         height += ( target.$.offsetHeight || 0 ) - ( target.$.clientHeight || 0 );\r
 205 \r
 206                                                                 target.setStyle( 'height', height + 'px' );\r
 207 \r
 208                                                                 // Fix IE < 8 visibility.\r
 209                                                                 panel._.currentBlock.element.setStyle( 'display', 'none' ).removeStyle( 'display' );\r
 210                                                         }\r
 211                                                         else\r
 212                                                                 element.getFirst().removeStyle( 'height' );\r
 213 \r
 214                                                         var panelElement = panel.element,\r
 215                                                                 panelWindow = panelElement.getWindow(),\r
 216                                                                 windowScroll = panelWindow.getScrollPosition(),\r
 217                                                                 viewportSize = panelWindow.getViewPaneSize(),\r
 218                                                                 panelSize =\r
 219                                                                 {\r
 220                                                                         'height' : panelElement.$.offsetHeight,\r
 221                                                                         'width' : panelElement.$.offsetWidth\r
 222                                                                 };\r
 223 \r
 224                                                         // If the menu is horizontal off, shift it toward\r
 225                                                         // the opposite language direction.\r
 226                                                         if ( rtl ? left < 0 : left + panelSize.width > viewportSize.width + windowScroll.x )\r
 227                                                                 left += ( panelSize.width * ( rtl ? 1 : -1 ) );\r
 228 \r
 229                                                         // Vertical off screen is simpler.\r
 230                                                         if( top + panelSize.height > viewportSize.height + windowScroll.y )\r
 231                                                                 top -= panelSize.height;\r
 232 \r
 233                                                         element.setStyles(\r
 234                                                                 {\r
 235                                                                         top : top + 'px',\r
 236                                                                         left : left + 'px',\r
 237                                                                         opacity : '1'\r
 238                                                                 } );\r
 239 \r
 240                                                 } , this );\r
 241 \r
 242                                                 panel.isLoaded ? panelLoad() : panel.onLoad = panelLoad;\r
 243 \r
 244                                                 // Set the panel frame focus, so the blur event gets fired.\r
 245                                                 CKEDITOR.tools.setTimeout( function()\r
 246                                                         {\r
 247                                                                 if ( definition.voiceLabel )\r
 248                                                                 {\r
 249                                                                         if ( CKEDITOR.env.gecko )\r
 250                                                                         {\r
 251                                                                                 var container = iframe.getParent();\r
 252                                                                                 container.setAttribute( 'role', 'region' );\r
 253                                                                                 container.setAttribute( 'title', definition.voiceLabel );\r
 254                                                                                 iframe.setAttribute( 'role', 'region' );\r
 255                                                                                 iframe.setAttribute( 'title', ' ' );\r
 256                                                                         }\r
 257                                                                 }\r
 258 \r
 259                                                                 iframe.$.contentWindow.focus();\r
 260                                                                 // We need this get fired manually because of unfired focus() function.\r
 261                                                                 this.allowBlur( true );\r
 262 \r
 263                                                         }, 0, this);\r
 264                                         }, 0, this);\r
 265                                 this.visible = 1;\r
 266 \r
 267                                 if ( this.onShow )\r
 268                                         this.onShow.call( this );\r
 269 \r
 270                                 isShowing = false;\r
 271                         },\r
 272 \r
 273                         hide : function()\r
 274                         {\r
 275                                 if ( this.visible && ( !this.onHide || this.onHide.call( this ) !== true ) )\r
 276                                 {\r
 277                                         this.hideChild();\r
 278                                         this.element.setStyle( 'display', 'none' );\r
 279                                         this.visible = 0;\r
 280                                 }\r
 281                         },\r
 282 \r
 283                         allowBlur : function( allow )   // Prevent editor from hiding the panel. #3222.\r
 284                         {\r
 285                                 var panel = this._.panel;\r
 286                                 if ( allow != undefined )\r
 287                                         panel.allowBlur = allow;\r
 288 \r
 289                                 return panel.allowBlur;\r
 290                         },\r
 291 \r
 292                         showAsChild : function( panel, blockName, offsetParent, corner, offsetX, offsetY )\r
 293                         {\r
 294                                 // Skip reshowing of child which is already visible.\r
 295                                 if ( this._.activeChild == panel && panel._.panel._.offsetParentId == offsetParent.getId() )\r
 296                                         return;\r
 297 \r
 298                                 this.hideChild();\r
 299 \r
 300                                 panel.onHide = CKEDITOR.tools.bind( function()\r
 301                                         {\r
 302                                                 // Use a timeout, so we give time for this menu to get\r
 303                                                 // potentially focused.\r
 304                                                 CKEDITOR.tools.setTimeout( function()\r
 305                                                         {\r
 306                                                                 if ( !this._.focused )\r
 307                                                                         this.hide();\r
 308                                                         },\r
 309                                                         0, this );\r
 310                                         },\r
 311                                         this );\r
 312 \r
 313                                 this._.activeChild = panel;\r
 314                                 this._.focused = false;\r
 315 \r
 316                                 panel.showBlock( blockName, offsetParent, corner, offsetX, offsetY );\r
 317 \r
 318                                 /* #3767 IE: Second level menu may not have borders */\r
 319                                 if ( CKEDITOR.env.ie7Compat || ( CKEDITOR.env.ie8 && CKEDITOR.env.ie6Compat ) )\r
 320                                 {\r
 321                                         setTimeout(function()\r
 322                                                 {\r
 323                                                         panel.element.getChild( 0 ).$.style.cssText += '';\r
 324                                                 }, 100);\r
 325                                 }\r
 326                         },\r
 327 \r
 328                         hideChild : function()\r
 329                         {\r
 330                                 var activeChild = this._.activeChild;\r
 331 \r
 332                                 if ( activeChild )\r
 333                                 {\r
 334                                         delete activeChild.onHide;\r
 335                                         delete this._.activeChild;\r
 336                                         activeChild.hide();\r
 337                                 }\r
 338                         }\r
 339                 }\r
 340         });\r
 341 \r
 342         CKEDITOR.on( 'instanceDestroyed', function()\r
 343         {\r
 344                 var isLastInstance = CKEDITOR.tools.isEmpty( CKEDITOR.instances );\r
 345 \r
 346                 for( var i in panels )\r
 347                 {\r
 348                         var panel = panels[ i ];\r
 349                         // Safe to destroy it since there're no more instances.(#4241)\r
 350                         if( isLastInstance )\r
 351                                 panel.destroy();\r
 352                         // Panel might be used by other instances, just hide them.(#4552)\r
 353                         else\r
 354                                 panel.element.hide();\r
 355                 }\r
 356                 // Remove the registration.\r
 357                 isLastInstance && ( panels = {} );\r
 358 \r
 359         } );\r
 360 })();\r