_source/plugins/richcombo/plugin.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 CKEDITOR.plugins.add( 'richcombo',\r
   7 {\r
   8         requires : [ 'floatpanel', 'listblock', 'button' ],\r
   9 \r
  10         beforeInit : function( editor )\r
  11         {\r
  12                 editor.ui.addHandler( CKEDITOR.UI_RICHCOMBO, CKEDITOR.ui.richCombo.handler );\r
  13         }\r
  14 });\r
  15 \r
  16 /**\r
  17  * Button UI element.\r
  18  * @constant\r
  19  * @example\r
  20  */\r
  21 CKEDITOR.UI_RICHCOMBO = 'richcombo';\r
  22 \r
  23 CKEDITOR.ui.richCombo = CKEDITOR.tools.createClass(\r
  24 {\r
  25         $ : function( definition )\r
  26         {\r
  27                 // Copy all definition properties to this object.\r
  28                 CKEDITOR.tools.extend( this, definition,\r
  29                         // Set defaults.\r
  30                         {\r
  31                                 title : definition.label,\r
  32                                 modes : { wysiwyg : 1 }\r
  33                         });\r
  34 \r
  35                 // We don't want the panel definition in this object.\r
  36                 var panelDefinition = this.panel || {};\r
  37                 delete this.panel;\r
  38 \r
  39                 this.id = CKEDITOR.tools.getNextNumber();\r
  40 \r
  41                 this.document = ( panelDefinition\r
  42                                                         && panelDefinition.parent\r
  43                                                         && panelDefinition.parent.getDocument() )\r
  44                                                 || CKEDITOR.document;\r
  45 \r
  46                 panelDefinition.className = ( panelDefinition.className || '' ) + ' cke_rcombopanel';\r
  47                 panelDefinition.block =\r
  48                 {\r
  49                         multiSelect : panelDefinition.multiSelect,\r
  50                         attributes : panelDefinition.attributes\r
  51                 };\r
  52 \r
  53                 this._ =\r
  54                 {\r
  55                         panelDefinition : panelDefinition,\r
  56                         items : {},\r
  57                         state : CKEDITOR.TRISTATE_OFF\r
  58                 };\r
  59         },\r
  60 \r
  61         statics :\r
  62         {\r
  63                 handler :\r
  64                 {\r
  65                         create : function( definition )\r
  66                         {\r
  67                                 return new CKEDITOR.ui.richCombo( definition );\r
  68                         }\r
  69                 }\r
  70         },\r
  71 \r
  72         proto :\r
  73         {\r
  74                 renderHtml : function( editor )\r
  75                 {\r
  76                         var output = [];\r
  77                         this.render( editor, output );\r
  78                         return output.join( '' );\r
  79                 },\r
  80 \r
  81                 /**\r
  82                  * Renders the combo.\r
  83                  * @param {CKEDITOR.editor} editor The editor instance which this button is\r
  84                  *              to be used by.\r
  85                  * @param {Array} output The output array to which append the HTML relative\r
  86                  *              to this button.\r
  87                  * @example\r
  88                  */\r
  89                 render : function( editor, output )\r
  90                 {\r
  91                         var env = CKEDITOR.env;\r
  92 \r
  93                         var id = 'cke_' + this.id;\r
  94                         var clickFn = CKEDITOR.tools.addFunction( function( $element )\r
  95                                 {\r
  96                                         var _ = this._;\r
  97 \r
  98                                         if ( _.state == CKEDITOR.TRISTATE_DISABLED )\r
  99                                                 return;\r
 100 \r
 101                                         this.createPanel( editor );\r
 102 \r
 103                                         if ( _.on )\r
 104                                         {\r
 105                                                 _.panel.hide();\r
 106                                                 return;\r
 107                                         }\r
 108 \r
 109                                         this.commit();\r
 110                                         var value = this.getValue();\r
 111                                         if ( value )\r
 112                                                 _.list.mark( value );\r
 113                                         else\r
 114                                                 _.list.unmarkAll();\r
 115 \r
 116                                         _.panel.showBlock( this.id, new CKEDITOR.dom.element( $element ), 4 );\r
 117                                 },\r
 118                                 this );\r
 119 \r
 120                         var instance = {\r
 121                                 id : id,\r
 122                                 combo : this,\r
 123                                 focus : function()\r
 124                                 {\r
 125                                         var element = CKEDITOR.document.getById( id ).getChild( 1 );\r
 126                                         element.focus();\r
 127                                 },\r
 128                                 clickFn : clickFn\r
 129                         };\r
 130 \r
 131                         function updateState()\r
 132                         {\r
 133                                 var state = this.modes[ editor.mode ] ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED;\r
 134                                 this.setState( editor.readOnly && !this.readOnly ? CKEDITOR.TRISTATE_DISABLED : state );\r
 135                                 this.setValue( '' );\r
 136                         }\r
 137 \r
 138                         editor.on( 'mode', updateState, this );\r
 139                         // If this combo is sensitive to readOnly state, update it accordingly.\r
 140                         !this.readOnly && editor.on( 'readOnly', updateState, this);\r
 141 \r
 142                         var keyDownFn = CKEDITOR.tools.addFunction( function( ev, element )\r
 143                                 {\r
 144                                         ev = new CKEDITOR.dom.event( ev );\r
 145 \r
 146                                         var keystroke = ev.getKeystroke();\r
 147                                         switch ( keystroke )\r
 148                                         {\r
 149                                                 case 13 :       // ENTER\r
 150                                                 case 32 :       // SPACE\r
 151                                                 case 40 :       // ARROW-DOWN\r
 152                                                         // Show panel\r
 153                                                         CKEDITOR.tools.callFunction( clickFn, element );\r
 154                                                         break;\r
 155                                                 default :\r
 156                                                         // Delegate the default behavior to toolbar button key handling.\r
 157                                                         instance.onkey( instance,  keystroke );\r
 158                                         }\r
 159 \r
 160                                         // Avoid subsequent focus grab on editor document.\r
 161                                         ev.preventDefault();\r
 162                                 });\r
 163 \r
 164                         // For clean up\r
 165                         instance.keyDownFn = keyDownFn;\r
 166 \r
 167                         output.push(\r
 168                                 '<span class="cke_rcombo" role="presentation">',\r
 169                                 '<span id=', id );\r
 170 \r
 171                         if ( this.className )\r
 172                                 output.push( ' class="', this.className, ' cke_off"');\r
 173 \r
 174                         output.push(\r
 175                                 ' role="presentation">',\r
 176                                         '<span id="' + id+ '_label" class=cke_label>', this.label, '</span>',\r
 177                                         '<a hidefocus=true title="', this.title, '" tabindex="-1"',\r
 178                                                 env.gecko && env.version >= 10900 && !env.hc ? '' : ' href="javascript:void(\'' + this.label + '\')"',\r
 179                                                 ' role="button" aria-labelledby="', id , '_label" aria-describedby="', id, '_text" aria-haspopup="true"' );\r
 180 \r
 181                         // Some browsers don't cancel key events in the keydown but in the\r
 182                         // keypress.\r
 183                         // TODO: Check if really needed for Gecko+Mac.\r
 184                         if ( CKEDITOR.env.opera || ( CKEDITOR.env.gecko && CKEDITOR.env.mac ) )\r
 185                         {\r
 186                                 output.push(\r
 187                                         ' onkeypress="return false;"' );\r
 188                         }\r
 189 \r
 190                         // With Firefox, we need to force it to redraw, otherwise it\r
 191                         // will remain in the focus state.\r
 192                         if ( CKEDITOR.env.gecko )\r
 193                         {\r
 194                                 output.push(\r
 195                                         ' onblur="this.style.cssText = this.style.cssText;"' );\r
 196                         }\r
 197 \r
 198                         output.push(\r
 199                                         ' onkeydown="CKEDITOR.tools.callFunction( ', keyDownFn, ', event, this );"' +\r
 200                                         ' onclick="CKEDITOR.tools.callFunction(', clickFn, ', this); return false;">' +\r
 201                                                 '<span>' +\r
 202                                                         '<span id="' + id + '_text" class="cke_text cke_inline_label">' + this.label + '</span>' +\r
 203                                                 '</span>' +\r
 204                                                 '<span class=cke_openbutton><span class=cke_icon>' + ( CKEDITOR.env.hc ? '&#9660;' : CKEDITOR.env.air ?  '&nbsp;' : '' ) + '</span></span>' +   // BLACK DOWN-POINTING TRIANGLE\r
 205                                         '</a>' +\r
 206                                 '</span>' +\r
 207                                 '</span>' );\r
 208 \r
 209                         if ( this.onRender )\r
 210                                 this.onRender();\r
 211 \r
 212                         return instance;\r
 213                 },\r
 214 \r
 215                 createPanel : function( editor )\r
 216                 {\r
 217                         if ( this._.panel )\r
 218                                 return;\r
 219 \r
 220                         var panelDefinition = this._.panelDefinition,\r
 221                                 panelBlockDefinition = this._.panelDefinition.block,\r
 222                                 panelParentElement = panelDefinition.parent || CKEDITOR.document.getBody(),\r
 223                                 panel = new CKEDITOR.ui.floatPanel( editor, panelParentElement, panelDefinition ),\r
 224                                 list = panel.addListBlock( this.id, panelBlockDefinition ),\r
 225                                 me = this;\r
 226 \r
 227                         panel.onShow = function()\r
 228                                 {\r
 229                                         if ( me.className )\r
 230                                                 this.element.getFirst().addClass( me.className + '_panel' );\r
 231 \r
 232                                         me.setState( CKEDITOR.TRISTATE_ON );\r
 233 \r
 234                                         list.focus( !me.multiSelect && me.getValue() );\r
 235 \r
 236                                         me._.on = 1;\r
 237 \r
 238                                         if ( me.onOpen )\r
 239                                                 me.onOpen();\r
 240                                 };\r
 241 \r
 242                         panel.onHide = function( preventOnClose )\r
 243                                 {\r
 244                                         if ( me.className )\r
 245                                                 this.element.getFirst().removeClass( me.className + '_panel' );\r
 246 \r
 247                                         me.setState( me.modes && me.modes[ editor.mode ] ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED );\r
 248 \r
 249                                         me._.on = 0;\r
 250 \r
 251                                         if ( !preventOnClose && me.onClose )\r
 252                                                 me.onClose();\r
 253                                 };\r
 254 \r
 255                         panel.onEscape = function()\r
 256                                 {\r
 257                                         panel.hide();\r
 258                                         me.document.getById( 'cke_' + me.id ).getFirst().getNext().focus();\r
 259                                 };\r
 260 \r
 261                         list.onClick = function( value, marked )\r
 262                                 {\r
 263                                         // Move the focus to the main windows, otherwise it will stay\r
 264                                         // into the floating panel, even if invisible, and Safari and\r
 265                                         // Opera will go a bit crazy.\r
 266                                         me.document.getWindow().focus();\r
 267 \r
 268                                         if ( me.onClick )\r
 269                                                 me.onClick.call( me, value, marked );\r
 270 \r
 271                                         if ( marked )\r
 272                                                 me.setValue( value, me._.items[ value ] );\r
 273                                         else\r
 274                                                 me.setValue( '' );\r
 275 \r
 276                                         panel.hide();\r
 277                                 };\r
 278 \r
 279                         this._.panel = panel;\r
 280                         this._.list = list;\r
 281 \r
 282                         panel.getBlock( this.id ).onHide = function()\r
 283                                 {\r
 284                                         me._.on = 0;\r
 285                                         me.setState( CKEDITOR.TRISTATE_OFF );\r
 286                                 };\r
 287 \r
 288                         if ( this.init )\r
 289                                 this.init();\r
 290                 },\r
 291 \r
 292                 setValue : function( value, text )\r
 293                 {\r
 294                         this._.value = value;\r
 295 \r
 296                         var textElement = this.document.getById( 'cke_' + this.id + '_text' );\r
 297                         if ( textElement )\r
 298                         {\r
 299                                 if ( !( value || text ) )\r
 300                                 {\r
 301                                         text = this.label;\r
 302                                         textElement.addClass( 'cke_inline_label' );\r
 303                                 }\r
 304                                 else\r
 305                                         textElement.removeClass( 'cke_inline_label' );\r
 306 \r
 307                                 textElement.setHtml( typeof text != 'undefined' ? text : value );\r
 308                         }\r
 309                 },\r
 310 \r
 311                 getValue : function()\r
 312                 {\r
 313                         return this._.value || '';\r
 314                 },\r
 315 \r
 316                 unmarkAll : function()\r
 317                 {\r
 318                         this._.list.unmarkAll();\r
 319                 },\r
 320 \r
 321                 mark : function( value )\r
 322                 {\r
 323                         this._.list.mark( value );\r
 324                 },\r
 325 \r
 326                 hideItem : function( value )\r
 327                 {\r
 328                         this._.list.hideItem( value );\r
 329                 },\r
 330 \r
 331                 hideGroup : function( groupTitle )\r
 332                 {\r
 333                         this._.list.hideGroup( groupTitle );\r
 334                 },\r
 335 \r
 336                 showAll : function()\r
 337                 {\r
 338                         this._.list.showAll();\r
 339                 },\r
 340 \r
 341                 add : function( value, html, text )\r
 342                 {\r
 343                         this._.items[ value ] = text || value;\r
 344                         this._.list.add( value, html, text );\r
 345                 },\r
 346 \r
 347                 startGroup : function( title )\r
 348                 {\r
 349                         this._.list.startGroup( title );\r
 350                 },\r
 351 \r
 352                 commit : function()\r
 353                 {\r
 354                         if ( !this._.committed )\r
 355                         {\r
 356                                 this._.list.commit();\r
 357                                 this._.committed = 1;\r
 358                                 CKEDITOR.ui.fire( 'ready', this );\r
 359                         }\r
 360                         this._.committed = 1;\r
 361                 },\r
 362 \r
 363                 setState : function( state )\r
 364                 {\r
 365                         if ( this._.state == state )\r
 366                                 return;\r
 367 \r
 368                         this.document.getById( 'cke_' + this.id ).setState( state );\r
 369 \r
 370                         this._.state = state;\r
 371                 }\r
 372         }\r
 373 });\r
 374 \r
 375 CKEDITOR.ui.prototype.addRichCombo = function( name, definition )\r
 376 {\r
 377         this.add( name, CKEDITOR.UI_RICHCOMBO, definition );\r
 378 };\r