Update to 4.7.3

[perso/Immae/Projets/packagist/ludivine-ckeditor-component.git] / sources / plugins / button / plugin.js

/**\r
 * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.\r
 * For licensing, see LICENSE.md or http://ckeditor.com/license\r
 */\r
\r
( function() {\r
	var template = '<a id="{id}"' +\r
		' class="cke_button cke_button__{name} cke_button_{state} {cls}"' +\r
		( CKEDITOR.env.gecko && !CKEDITOR.env.hc ? '' : ' href="javascript:void(\'{titleJs}\')"' ) +\r
		' title="{title}"' +\r
		' tabindex="-1"' +\r
		' hidefocus="true"' +\r
		' role="button"' +\r
		' aria-labelledby="{id}_label"' +\r
		' aria-describedby="{id}_description"' +\r
		' aria-haspopup="{hasArrow}"' +\r
		' aria-disabled="{ariaDisabled}"';\r
\r
	// Some browsers don't cancel key events in the keydown but in the\r
	// keypress.\r
	// TODO: Check if really needed.\r
	if ( CKEDITOR.env.gecko && CKEDITOR.env.mac )\r
		template += ' onkeypress="return false;"';\r
\r
	// With Firefox, we need to force the button to redraw, otherwise it\r
	// will remain in the focus state.\r
	if ( CKEDITOR.env.gecko )\r
		template += ' onblur="this.style.cssText = this.style.cssText;"';\r
\r
	template += ' onkeydown="return CKEDITOR.tools.callFunction({keydownFn},event);"' +\r
		' onfocus="return CKEDITOR.tools.callFunction({focusFn},event);" ' +\r
		( CKEDITOR.env.ie ? 'onclick="return false;" onmouseup' : 'onclick' ) + // http://dev.ckeditor.com/ticket/188\r
			'="CKEDITOR.tools.callFunction({clickFn},this);return false;">' +\r
		'<span class="cke_button_icon cke_button__{iconName}_icon" style="{style}"';\r
\r
\r
	template += '>&nbsp;</span>' +\r
		'<span id="{id}_label" class="cke_button_label cke_button__{name}_label" aria-hidden="false">{label}</span>' +\r
		'<span id="{id}_description" class="cke_button_label" aria-hidden="false">{ariaShortcut}</span>' +\r
		'{arrowHtml}' +\r
		'</a>';\r
\r
	var templateArrow = '<span class="cke_button_arrow">' +\r
		// BLACK DOWN-POINTING TRIANGLE\r
	( CKEDITOR.env.hc ? '&#9660;' : '' ) +\r
		'</span>';\r
\r
	var btnArrowTpl = CKEDITOR.addTemplate( 'buttonArrow', templateArrow ),\r
		btnTpl = CKEDITOR.addTemplate( 'button', template );\r
\r
	CKEDITOR.plugins.add( 'button', {\r
		lang: 'af,ar,az,bg,ca,cs,da,de,de-ch,el,en,en-gb,eo,es,es-mx,eu,fa,fi,fr,gl,he,hr,hu,id,it,ja,km,ko,ku,lt,nb,nl,no,oc,pl,pt,pt-br,ro,ru,sk,sl,sq,sv,tr,tt,ug,uk,vi,zh,zh-cn', // %REMOVE_LINE_CORE%\r
		beforeInit: function( editor ) {\r
			editor.ui.addHandler( CKEDITOR.UI_BUTTON, CKEDITOR.ui.button.handler );\r
		}\r
	} );\r
\r
	/**\r
	 * Button UI element.\r
	 *\r
	 * @readonly\r
	 * @property {String} [='button']\r
	 * @member CKEDITOR\r
	 */\r
	CKEDITOR.UI_BUTTON = 'button';\r
\r
	/**\r
	 * Represents a button UI element. This class should not be called directly. To\r
	 * create new buttons use {@link CKEDITOR.ui#addButton} instead.\r
	 *\r
	 * @class\r
	 * @constructor Creates a button class instance.\r
	 * @param {Object} definition The button definition.\r
	 */\r
	CKEDITOR.ui.button = function( definition ) {\r
		CKEDITOR.tools.extend( this, definition,\r
		// Set defaults.\r
		{\r
			title: definition.label,\r
			click: definition.click ||\r
			function( editor ) {\r
				editor.execCommand( definition.command );\r
			}\r
		} );\r
\r
		this._ = {};\r
	};\r
\r
	/**\r
	 * Represents the button handler object.\r
	 *\r
	 * @class\r
	 * @singleton\r
	 * @extends CKEDITOR.ui.handlerDefinition\r
	 */\r
	CKEDITOR.ui.button.handler = {\r
		/**\r
		 * Transforms a button definition in a {@link CKEDITOR.ui.button} instance.\r
		 *\r
		 * @member CKEDITOR.ui.button.handler\r
		 * @param {Object} definition\r
		 * @returns {CKEDITOR.ui.button}\r
		 */\r
		create: function( definition ) {\r
			return new CKEDITOR.ui.button( definition );\r
		}\r
	};\r
\r
	/** @class CKEDITOR.ui.button */\r
	CKEDITOR.ui.button.prototype = {\r
		/**\r
		 * Renders the button.\r
		 *\r
		 * @param {CKEDITOR.editor} editor The editor instance which this button is\r
		 * to be used by.\r
		 * @param {Array} output The output array to which the HTML code related to\r
		 * this button should be appended.\r
		 */\r
		render: function( editor, output ) {\r
			function updateState() {\r
				// "this" is a CKEDITOR.ui.button instance.\r
				var mode = editor.mode;\r
\r
				if ( mode ) {\r
					// Restore saved button state.\r
					var state = this.modes[ mode ] ? modeStates[ mode ] !== undefined ? modeStates[ mode ] : CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED;\r
\r
					state = editor.readOnly && !this.readOnly ? CKEDITOR.TRISTATE_DISABLED : state;\r
\r
					this.setState( state );\r
\r
					// Let plugin to disable button.\r
					if ( this.refresh )\r
						this.refresh();\r
				}\r
			}\r
\r
			var env = CKEDITOR.env,\r
				id = this._.id = CKEDITOR.tools.getNextId(),\r
				stateName = '',\r
				command = this.command,\r
				// Get the command name.\r
				clickFn,\r
				keystroke,\r
				shortcut;\r
\r
			this._.editor = editor;\r
\r
			var instance = {\r
				id: id,\r
				button: this,\r
				editor: editor,\r
				focus: function() {\r
					var element = CKEDITOR.document.getById( id );\r
					element.focus();\r
				},\r
				execute: function() {\r
					this.button.click( editor );\r
				},\r
				attach: function( editor ) {\r
					this.button.attach( editor );\r
				}\r
			};\r
\r
			var keydownFn = CKEDITOR.tools.addFunction( function( ev ) {\r
				if ( instance.onkey ) {\r
					ev = new CKEDITOR.dom.event( ev );\r
					return ( instance.onkey( instance, ev.getKeystroke() ) !== false );\r
				}\r
			} );\r
\r
			var focusFn = CKEDITOR.tools.addFunction( function( ev ) {\r
				var retVal;\r
\r
				if ( instance.onfocus )\r
					retVal = ( instance.onfocus( instance, new CKEDITOR.dom.event( ev ) ) !== false );\r
\r
				return retVal;\r
			} );\r
\r
			var selLocked = 0;\r
\r
			instance.clickFn = clickFn = CKEDITOR.tools.addFunction( function() {\r
\r
				// Restore locked selection in Opera.\r
				if ( selLocked ) {\r
					editor.unlockSelection( 1 );\r
					selLocked = 0;\r
				}\r
				instance.execute();\r
\r
				// Fixed iOS focus issue when your press disabled button (http://dev.ckeditor.com/ticket/12381).\r
				if ( env.iOS ) {\r
					editor.focus();\r
				}\r
			} );\r
\r
\r
			// Indicate a mode sensitive button.\r
			if ( this.modes ) {\r
				var modeStates = {};\r
\r
				editor.on( 'beforeModeUnload', function() {\r
					if ( editor.mode && this._.state != CKEDITOR.TRISTATE_DISABLED )\r
						modeStates[ editor.mode ] = this._.state;\r
				}, this );\r
\r
				// Update status when activeFilter, mode or readOnly changes.\r
				editor.on( 'activeFilterChange', updateState, this );\r
				editor.on( 'mode', updateState, this );\r
				// If this button is sensitive to readOnly state, update it accordingly.\r
				!this.readOnly && editor.on( 'readOnly', updateState, this );\r
\r
			} else if ( command ) {\r
				// Get the command instance.\r
				command = editor.getCommand( command );\r
\r
				if ( command ) {\r
					command.on( 'state', function() {\r
						this.setState( command.state );\r
					}, this );\r
\r
					stateName += ( command.state == CKEDITOR.TRISTATE_ON ? 'on' : command.state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' : 'off' );\r
				}\r
			}\r
\r
			// For button that has text-direction awareness on selection path.\r
			if ( this.directional ) {\r
				editor.on( 'contentDirChanged', function( evt ) {\r
					var el = CKEDITOR.document.getById( this._.id ),\r
						icon = el.getFirst();\r
\r
					var pathDir = evt.data;\r
\r
					// Make a minor direction change to become style-able for the skin icon.\r
					if ( pathDir !=  editor.lang.dir )\r
						el.addClass( 'cke_' + pathDir );\r
					else\r
						el.removeClass( 'cke_ltr' ).removeClass( 'cke_rtl' );\r
\r
					// Inline style update for the plugin icon.\r
					icon.setAttribute( 'style', CKEDITOR.skin.getIconStyle( iconName, pathDir == 'rtl', this.icon, this.iconOffset ) );\r
				}, this );\r
			}\r
\r
			if ( !command ) {\r
				stateName += 'off';\r
			} else {\r
				keystroke = editor.getCommandKeystroke( command );\r
\r
				if ( keystroke ) {\r
					shortcut = CKEDITOR.tools.keystrokeToString( editor.lang.common.keyboard, keystroke );\r
				}\r
			}\r
\r
			var name = this.name || this.command,\r
				iconName = name;\r
\r
			// Check if we're pointing to an icon defined by another command. (http://dev.ckeditor.com/ticket/9555)\r
			if ( this.icon && !( /\./ ).test( this.icon ) ) {\r
				iconName = this.icon;\r
				this.icon = null;\r
			}\r
\r
			var params = {\r
				id: id,\r
				name: name,\r
				iconName: iconName,\r
				label: this.label,\r
				cls: this.className || '',\r
				state: stateName,\r
				ariaDisabled: stateName == 'disabled' ? 'true' : 'false',\r
				title: this.title + ( shortcut ? ' (' + shortcut.display + ')' : '' ),\r
				ariaShortcut: shortcut ? editor.lang.common.keyboardShortcut + ' ' + shortcut.aria : '',\r
				titleJs: env.gecko && !env.hc ? '' : ( this.title || '' ).replace( "'", '' ),\r
				hasArrow: this.hasArrow ? 'true' : 'false',\r
				keydownFn: keydownFn,\r
				focusFn: focusFn,\r
				clickFn: clickFn,\r
				style: CKEDITOR.skin.getIconStyle( iconName, ( editor.lang.dir == 'rtl' ), this.icon, this.iconOffset ),\r
				arrowHtml: this.hasArrow ? btnArrowTpl.output() : ''\r
			};\r
\r
			btnTpl.output( params, output );\r
\r
			if ( this.onRender )\r
				this.onRender();\r
\r
			return instance;\r
		},\r
\r
		/**\r
		 * Sets the button state.\r
		 *\r
		 * @param {Number} state Indicates the button state. One of {@link CKEDITOR#TRISTATE_ON},\r
		 * {@link CKEDITOR#TRISTATE_OFF}, or {@link CKEDITOR#TRISTATE_DISABLED}.\r
		 */\r
		setState: function( state ) {\r
			if ( this._.state == state )\r
				return false;\r
\r
			this._.state = state;\r
\r
			var element = CKEDITOR.document.getById( this._.id );\r
\r
			if ( element ) {\r
				element.setState( state, 'cke_button' );\r
\r
				state == CKEDITOR.TRISTATE_DISABLED ?\r
					element.setAttribute( 'aria-disabled', true ) :\r
					element.removeAttribute( 'aria-disabled' );\r
\r
				if ( !this.hasArrow ) {\r
					// Note: aria-pressed attribute should not be added to menuButton instances. (http://dev.ckeditor.com/ticket/11331)\r
					state == CKEDITOR.TRISTATE_ON ?\r
						element.setAttribute( 'aria-pressed', true ) :\r
						element.removeAttribute( 'aria-pressed' );\r
				} else {\r
					var newLabel = state == CKEDITOR.TRISTATE_ON ?\r
						this._.editor.lang.button.selectedLabel.replace( /%1/g, this.label ) : this.label;\r
					CKEDITOR.document.getById( this._.id + '_label' ).setText( newLabel );\r
				}\r
\r
				return true;\r
			} else {\r
				return false;\r
			}\r
		},\r
\r
		/**\r
		 * Gets the button state.\r
		 *\r
		 * @returns {Number} The button state. One of {@link CKEDITOR#TRISTATE_ON},\r
		 * {@link CKEDITOR#TRISTATE_OFF}, or {@link CKEDITOR#TRISTATE_DISABLED}.\r
		 */\r
		getState: function() {\r
			return this._.state;\r
		},\r
\r
		/**\r
		 * Returns this button's {@link CKEDITOR.feature} instance.\r
		 *\r
		 * It may be this button instance if it has at least one of\r
		 * `allowedContent` and `requiredContent` properties. Otherwise,\r
		 * if a command is bound to this button by the `command` property, then\r
		 * that command will be returned.\r
		 *\r
		 * This method implements the {@link CKEDITOR.feature#toFeature} interface method.\r
		 *\r
		 * @since 4.1\r
		 * @param {CKEDITOR.editor} Editor instance.\r
		 * @returns {CKEDITOR.feature} The feature.\r
		 */\r
		toFeature: function( editor ) {\r
			if ( this._.feature )\r
				return this._.feature;\r
\r
			var feature = this;\r
\r
			// If button isn't a feature, return command if is bound.\r
			if ( !this.allowedContent && !this.requiredContent && this.command )\r
				feature = editor.getCommand( this.command ) || feature;\r
\r
			return this._.feature = feature;\r
		}\r
	};\r
\r
	/**\r
	 * Adds a button definition to the UI elements list.\r
	 *\r
	 *		editorInstance.ui.addButton( 'MyBold', {\r
	 *			label: 'My Bold',\r
	 *			command: 'bold',\r
	 *			toolbar: 'basicstyles,1'\r
	 *		} );\r
	 *\r
	 * @member CKEDITOR.ui\r
	 * @param {String} name The button name.\r
	 * @param {Object} definition The button definition.\r
	 * @param {String} definition.label The textual part of the button (if visible) and its tooltip.\r
	 * @param {String} definition.command The command to be executed once the button is activated.\r
	 * @param {String} definition.toolbar The {@link CKEDITOR.config#toolbarGroups toolbar group} into which\r
	 * the button will be added. An optional index value (separated by a comma) determines the button position within the group.\r
	 */\r
	CKEDITOR.ui.prototype.addButton = function( name, definition ) {\r
		this.add( name, CKEDITOR.UI_BUTTON, definition );\r
	};\r
\r
} )();\r