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