diff options
| author | Lester Caine <lsces@lsces.co.uk> | 2010-07-29 20:31:06 +0100 |
|---|---|---|
| committer | Lester Caine <lsces@lsces.co.uk> | 2010-07-29 20:31:06 +0100 |
| commit | 1a293c5c57779b3750b561b5fe295aff33b3ebf9 (patch) | |
| tree | 254fc36fc473e7d60b88324d550ce95f94e18cca /_source/plugins/button/plugin.js | |
| parent | 33c69a19cc35f82336bce6020b15e33152ff8763 (diff) | |
| download | ckeditor-1a293c5c57779b3750b561b5fe295aff33b3ebf9.tar.gz ckeditor-1a293c5c57779b3750b561b5fe295aff33b3ebf9.tar.bz2 ckeditor-1a293c5c57779b3750b561b5fe295aff33b3ebf9.zip | |
ync with version 3.3.1 of CKEditor
Diffstat (limited to '_source/plugins/button/plugin.js')
| -rw-r--r-- | _source/plugins/button/plugin.js | 547 |
1 files changed, 277 insertions, 270 deletions
diff --git a/_source/plugins/button/plugin.js b/_source/plugins/button/plugin.js index b211a28..26909bc 100644 --- a/_source/plugins/button/plugin.js +++ b/_source/plugins/button/plugin.js @@ -1,270 +1,277 @@ -/*
-Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
-For licensing, see LICENSE.html or http://ckeditor.com/license
-*/
-
-CKEDITOR.plugins.add( 'button',
-{
- beforeInit : function( editor )
- {
- editor.ui.addHandler( CKEDITOR.UI_BUTTON, CKEDITOR.ui.button.handler );
- }
-});
-
-/**
- * Button UI element.
- * @constant
- * @example
- */
-CKEDITOR.UI_BUTTON = 1;
-
-/**
- * Represents a button UI element. This class should not be called directly. To
- * create new buttons use {@link CKEDITOR.ui.prototype.addButton} instead.
- * @constructor
- * @param {Object} definition The button definition.
- * @example
- */
-CKEDITOR.ui.button = function( definition )
-{
- // Copy all definition properties to this object.
- CKEDITOR.tools.extend( this, definition,
- // Set defaults.
- {
- title : definition.label,
- className : definition.className || ( definition.command && 'cke_button_' + definition.command ) || '',
- click : definition.click || function( editor )
- {
- editor.execCommand( definition.command );
- }
- });
-
- this._ = {};
-};
-
-/**
- * Transforms a button definition in a {@link CKEDITOR.ui.button} instance.
- * @type Object
- * @example
- */
-CKEDITOR.ui.button.handler =
-{
- create : function( definition )
- {
- return new CKEDITOR.ui.button( definition );
- }
-};
-
-CKEDITOR.ui.button.prototype =
-{
- canGroup : true,
-
- /**
- * Renders the button.
- * @param {CKEDITOR.editor} editor The editor instance which this button is
- * to be used by.
- * @param {Array} output The output array to which append the HTML relative
- * to this button.
- * @example
- */
- render : function( editor, output )
- {
- var env = CKEDITOR.env;
-
- var id = this._.id = 'cke_' + CKEDITOR.tools.getNextNumber();
- this._.editor = editor;
-
- var instance =
- {
- id : id,
- button : this,
- editor : editor,
- focus : function()
- {
- var element = CKEDITOR.document.getById( id );
- element.focus();
- },
- execute : function()
- {
- this.button.click( editor );
- }
- };
-
- var clickFn = CKEDITOR.tools.addFunction( instance.execute, instance );
-
- var index = CKEDITOR.ui.button._.instances.push( instance ) - 1;
-
- var classes = '';
-
- // Get the command name.
- var command = this.command;
-
- if ( this.modes )
- {
- editor.on( 'mode', function()
- {
- this.setState( this.modes[ editor.mode ] ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED );
- }, this);
- }
- else if ( command )
- {
- // Get the command instance.
- command = editor.getCommand( command );
-
- if ( command )
- {
- command.on( 'state', function()
- {
- this.setState( command.state );
- }, this);
-
- classes += 'cke_' + (
- command.state == CKEDITOR.TRISTATE_ON ? 'on' :
- command.state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' :
- 'off' );
- }
- }
-
- if ( !command )
- classes += 'cke_off';
-
- if ( this.className )
- classes += ' ' + this.className;
-
- output.push(
- '<span class="cke_button">',
- '<a id="', id, '"' +
- ' class="', classes, '"',
- env.gecko && env.version >= 10900 && !env.hc ? '' : '" href="javascript:void(\''+ ( this.title || '' ).replace( "'"+ '' )+ '\')"',
- ' title="', this.title, '"' +
- ' tabindex="-1"' +
- ' hidefocus="true"' +
- ' role="button"' +
- ' aria-labelledby="' + id + '_label"' +
- ( this.hasArrow ? ' aria-haspopup="true"' : '' ) );
-
- // Some browsers don't cancel key events in the keydown but in the
- // keypress.
- // TODO: Check if really needed for Gecko+Mac.
- if ( env.opera || ( env.gecko && env.mac ) )
- {
- output.push(
- ' onkeypress="return false;"' );
- }
-
- // With Firefox, we need to force the button to redraw, otherwise it
- // will remain in the focus state.
- if ( env.gecko )
- {
- output.push(
- ' onblur="this.style.cssText = this.style.cssText;"' );
- }
-
- output.push(
- ' onkeydown="return CKEDITOR.ui.button._.keydown(', index, ', event);"' +
- ' onfocus="return CKEDITOR.ui.button._.focus(', index, ', event);"' +
- ' onclick="CKEDITOR.tools.callFunction(', clickFn, ', this); return false;">' +
- '<span class="cke_icon"' );
-
- if ( this.icon )
- {
- var offset = ( this.iconOffset || 0 ) * -16;
- output.push( ' style="background-image:url(', CKEDITOR.getUrl( this.icon ), ');background-position:0 ' + offset + 'px;"' );
- }
-
- output.push(
- '></span>' +
- '<span id="', id, '_label" class="cke_label">', this.label, '</span>' );
-
- if ( this.hasArrow )
- {
- output.push(
- '<span class="cke_buttonarrow"></span>' );
- }
-
- output.push(
- '</a>',
- '</span>' );
-
- if ( this.onRender )
- this.onRender();
-
- return instance;
- },
-
- setState : function( state )
- {
- if ( this._.state == state )
- return false;
-
- this._.state = state;
-
- var element = CKEDITOR.document.getById( this._.id );
-
- if ( element )
- {
- element.setState( state );
- state == CKEDITOR.TRISTATE_DISABLED ?
- element.setAttribute( 'aria-disabled', true ) :
- element.removeAttribute( 'aria-disabled' );
-
- state == CKEDITOR.TRISTATE_ON ?
- element.setAttribute( 'aria-pressed', true ) :
- element.removeAttribute( 'aria-pressed' );
-
- return true;
- }
- else
- return false;
- }
-};
-
-/**
- * Handles a button click.
- * @private
- */
-CKEDITOR.ui.button._ =
-{
- instances : [],
-
- keydown : function( index, ev )
- {
- var instance = CKEDITOR.ui.button._.instances[ index ];
-
- if ( instance.onkey )
- {
- ev = new CKEDITOR.dom.event( ev );
- return ( instance.onkey( instance, ev.getKeystroke() ) !== false );
- }
- },
-
- focus : function( index, ev )
- {
- var instance = CKEDITOR.ui.button._.instances[ index ],
- retVal;
-
- if ( instance.onfocus )
- retVal = ( instance.onfocus( instance, new CKEDITOR.dom.event( ev ) ) !== false );
-
- // FF2: prevent focus event been bubbled up to editor container, which caused unexpected editor focus.
- if ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 )
- ev.preventBubble();
- return retVal;
- }
-};
-
-/**
- * Adds a button definition to the UI elements list.
- * @param {String} The button name.
- * @param {Object} The button definition.
- * @example
- * editorInstance.ui.addButton( 'MyBold',
- * {
- * label : 'My Bold',
- * command : 'bold'
- * });
- */
-CKEDITOR.ui.prototype.addButton = function( name, definition )
-{
- this.add( name, CKEDITOR.UI_BUTTON, definition );
-};
+/* +Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved. +For licensing, see LICENSE.html or http://ckeditor.com/license +*/ + +CKEDITOR.plugins.add( 'button', +{ + beforeInit : function( editor ) + { + editor.ui.addHandler( CKEDITOR.UI_BUTTON, CKEDITOR.ui.button.handler ); + } +}); + +/** + * Button UI element. + * @constant + * @example + */ +CKEDITOR.UI_BUTTON = 1; + +/** + * Represents a button UI element. This class should not be called directly. To + * create new buttons use {@link CKEDITOR.ui.prototype.addButton} instead. + * @constructor + * @param {Object} definition The button definition. + * @example + */ +CKEDITOR.ui.button = function( definition ) +{ + // Copy all definition properties to this object. + CKEDITOR.tools.extend( this, definition, + // Set defaults. + { + title : definition.label, + className : definition.className || ( definition.command && 'cke_button_' + definition.command ) || '', + click : definition.click || function( editor ) + { + editor.execCommand( definition.command ); + } + }); + + this._ = {}; +}; + +/** + * Transforms a button definition in a {@link CKEDITOR.ui.button} instance. + * @type Object + * @example + */ +CKEDITOR.ui.button.handler = +{ + create : function( definition ) + { + return new CKEDITOR.ui.button( definition ); + } +}; + +CKEDITOR.ui.button.prototype = +{ + canGroup : true, + + /** + * Renders the button. + * @param {CKEDITOR.editor} editor The editor instance which this button is + * to be used by. + * @param {Array} output The output array to which append the HTML relative + * to this button. + * @example + */ + render : function( editor, output ) + { + var env = CKEDITOR.env, + id = this._.id = 'cke_' + CKEDITOR.tools.getNextNumber(), + classes = '', + command = this.command, // Get the command name. + clickFn, + index; + + this._.editor = editor; + + var instance = + { + id : id, + button : this, + editor : editor, + focus : function() + { + var element = CKEDITOR.document.getById( id ); + element.focus(); + }, + execute : function() + { + this.button.click( editor ); + } + }; + + instance.clickFn = clickFn = CKEDITOR.tools.addFunction( instance.execute, instance ); + + instance.index = index = CKEDITOR.ui.button._.instances.push( instance ) - 1; + + if ( this.modes ) + { + editor.on( 'mode', function() + { + this.setState( this.modes[ editor.mode ] ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED ); + }, this); + } + else if ( command ) + { + // Get the command instance. + command = editor.getCommand( command ); + + if ( command ) + { + command.on( 'state', function() + { + this.setState( command.state ); + }, this); + + classes += 'cke_' + ( + command.state == CKEDITOR.TRISTATE_ON ? 'on' : + command.state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' : + 'off' ); + } + } + + if ( !command ) + classes += 'cke_off'; + + if ( this.className ) + classes += ' ' + this.className; + + output.push( + '<span class="cke_button">', + '<a id="', id, '"' + + ' class="', classes, '"', + env.gecko && env.version >= 10900 && !env.hc ? '' : '" href="javascript:void(\''+ ( this.title || '' ).replace( "'"+ '' )+ '\')"', + ' title="', this.title, '"' + + ' tabindex="-1"' + + ' hidefocus="true"' + + ' role="button"' + + ' aria-labelledby="' + id + '_label"' + + ( this.hasArrow ? ' aria-haspopup="true"' : '' ) ); + + // Some browsers don't cancel key events in the keydown but in the + // keypress. + // TODO: Check if really needed for Gecko+Mac. + if ( env.opera || ( env.gecko && env.mac ) ) + { + output.push( + ' onkeypress="return false;"' ); + } + + // With Firefox, we need to force the button to redraw, otherwise it + // will remain in the focus state. + if ( env.gecko ) + { + output.push( + ' onblur="this.style.cssText = this.style.cssText;"' ); + } + + output.push( + ' onkeydown="return CKEDITOR.ui.button._.keydown(', index, ', event);"' + + ' onfocus="return CKEDITOR.ui.button._.focus(', index, ', event);"' + + ' onclick="CKEDITOR.tools.callFunction(', clickFn, ', this); return false;">' + + '<span class="cke_icon"' ); + + if ( this.icon ) + { + var offset = ( this.iconOffset || 0 ) * -16; + output.push( ' style="background-image:url(', CKEDITOR.getUrl( this.icon ), ');background-position:0 ' + offset + 'px;"' ); + } + + output.push( + '> </span>' + + '<span id="', id, '_label" class="cke_label">', this.label, '</span>' ); + + if ( this.hasArrow ) + { + output.push( + '<span class="cke_buttonarrow">' + // BLACK DOWN-POINTING TRIANGLE + + ( CKEDITOR.env.hc ? '▼' : ' ' ) + + '</span>' ); + } + + output.push( + '</a>', + '</span>' ); + + if ( this.onRender ) + this.onRender(); + + return instance; + }, + + setState : function( state ) + { + if ( this._.state == state ) + return false; + + this._.state = state; + + var element = CKEDITOR.document.getById( this._.id ); + + if ( element ) + { + element.setState( state ); + state == CKEDITOR.TRISTATE_DISABLED ? + element.setAttribute( 'aria-disabled', true ) : + element.removeAttribute( 'aria-disabled' ); + + state == CKEDITOR.TRISTATE_ON ? + element.setAttribute( 'aria-pressed', true ) : + element.removeAttribute( 'aria-pressed' ); + + return true; + } + else + return false; + } +}; + +/** + * Handles a button click. + * @private + */ +CKEDITOR.ui.button._ = +{ + instances : [], + + keydown : function( index, ev ) + { + var instance = CKEDITOR.ui.button._.instances[ index ]; + + if ( instance.onkey ) + { + ev = new CKEDITOR.dom.event( ev ); + return ( instance.onkey( instance, ev.getKeystroke() ) !== false ); + } + }, + + focus : function( index, ev ) + { + var instance = CKEDITOR.ui.button._.instances[ index ], + retVal; + + if ( instance.onfocus ) + retVal = ( instance.onfocus( instance, new CKEDITOR.dom.event( ev ) ) !== false ); + + // FF2: prevent focus event been bubbled up to editor container, which caused unexpected editor focus. + if ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 ) + ev.preventBubble(); + return retVal; + } +}; + +/** + * Adds a button definition to the UI elements list. + * @param {String} The button name. + * @param {Object} The button definition. + * @example + * editorInstance.ui.addButton( 'MyBold', + * { + * label : 'My Bold', + * command : 'bold' + * }); + */ +CKEDITOR.ui.prototype.addButton = function( name, definition ) +{ + this.add( name, CKEDITOR.UI_BUTTON, definition ); +}; + +CKEDITOR.on( 'reset', function() + { + CKEDITOR.ui.button._.instances = []; + }); |
