/**
* @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
CKEDITOR.plugins.add("format", {
requires: "richcombo",
// jscs:disable maximumLineLength
lang:
"af,ar,az,bg,bn,bs,ca,cs,cy,da,de,de-ch,el,en,en-au,en-ca,en-gb,eo,es,es-mx,et,eu,fa,fi,fo,fr,fr-ca,gl,gu,he,hi,hr,hu,id,is,it,ja,ka,km,ko,ku,lt,lv,mk,mn,ms,nb,nl,no,oc,pl,pt,pt-br,ro,ru,si,sk,sl,sq,sr,sr-latn,sv,th,tr,tt,ug,uk,vi,zh,zh-cn", // %REMOVE_LINE_CORE%
// jscs:enable maximumLineLength
init: function(editor) {
if (editor.blockless) return;
var config = editor.config,
lang = editor.lang.format;
// Gets the list of tags from the settings.
var tags = config.format_tags.split(";");
// Create style objects for all defined styles.
var styles = {},
stylesCount = 0,
allowedContent = [];
for (var i = 0; i < tags.length; i++) {
var tag = tags[i];
var style = new CKEDITOR.style(config["format_" + tag]);
if (!editor.filter.customConfig || editor.filter.check(style)) {
stylesCount++;
styles[tag] = style;
styles[tag]._.enterMode = editor.config.enterMode;
allowedContent.push(style);
}
}
// Hide entire combo when all formats are rejected.
if (stylesCount === 0) return;
editor.ui.addRichCombo("Format", {
label: lang.label,
title: lang.panelTitle,
toolbar: "styles,20",
allowedContent: allowedContent,
panel: {
css: [CKEDITOR.skin.getPath("editor")].concat(config.contentsCss),
multiSelect: false,
attributes: { "aria-label": lang.panelTitle }
},
init: function() {
this.startGroup(lang.panelTitle);
for (var tag in styles) {
var label = lang["tag_" + tag];
// Add the tag entry to the panel list.
this.add(tag, styles[tag].buildPreview(label), label);
}
},
onClick: function(value) {
editor.focus();
editor.fire("saveSnapshot");
var style = styles[value],
elementPath = editor.elementPath();
// Always apply style, do not allow to toggle it by clicking on corresponding list item (#584).
if (!style.checkActive(elementPath, editor)) {
editor.applyStyle(style);
}
// Save the undo snapshot after all changes are affected. (https://dev.ckeditor.com/ticket/4899)
setTimeout(function() {
editor.fire("saveSnapshot");
}, 0);
},
onRender: function() {
editor.on(
"selectionChange",
function(ev) {
var currentTag = this.getValue(),
elementPath = ev.data.path;
this.refresh();
for (var tag in styles) {
if (styles[tag].checkActive(elementPath, editor)) {
if (tag != currentTag)
this.setValue(tag, editor.lang.format["tag_" + tag]);
return;
}
}
// If no styles match, just empty it.
this.setValue("");
},
this
);
},
onOpen: function() {
this.showAll();
for (var name in styles) {
var style = styles[name];
// Check if that style is enabled in activeFilter.
if (!editor.activeFilter.check(style)) this.hideItem(name);
}
},
refresh: function() {
var elementPath = editor.elementPath();
if (!elementPath) return;
// Check if element path contains 'p' element.
if (!elementPath.isContextFor("p")) {
this.setState(CKEDITOR.TRISTATE_DISABLED);
return;
}
// Check if there is any available style.
for (var name in styles) {
if (editor.activeFilter.check(styles[name])) return;
}
this.setState(CKEDITOR.TRISTATE_DISABLED);
}
});
}
});
/**
* A list of semicolon-separated style names (by default: tags) representing
* the style definition for each entry to be displayed in the Format drop-down list
* in the toolbar. Each entry must have a corresponding configuration in a
* setting named `'format_(tagName)'`. For example, the `'p'` entry has its
* definition taken from [config.format_p](#!/api/CKEDITOR.config-cfg-format_p).
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_tags = 'p;h2;h3;pre';
*
* @cfg {String} [format_tags='p;h1;h2;h3;h4;h5;h6;pre;address;div']
* @member CKEDITOR.config
*/
CKEDITOR.config.format_tags = "p;h1;h2;h3;h4;h5;h6;pre;address;div";
/**
* The style definition to be used to apply the `Normal` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_p = { element: 'p', attributes: { 'class': 'normalPara' } };
*
* @cfg {Object} [format_p={ element: 'p' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_p = { element: "p" };
/**
* The style definition to be used to apply the `Normal (DIV)` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_div = { element: 'div', attributes: { 'class': 'normalDiv' } };
*
* @cfg {Object} [format_div={ element: 'div' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_div = { element: "div" };
/**
* The style definition to be used to apply the `Formatted` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_pre = { element: 'pre', attributes: { 'class': 'code' } };
*
* @cfg {Object} [format_pre={ element: 'pre' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_pre = { element: "pre" };
/**
* The style definition to be used to apply the `Address` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_address = { element: 'address', attributes: { 'class': 'styledAddress' } };
*
* @cfg {Object} [format_address={ element: 'address' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_address = { element: "address" };
/**
* The style definition to be used to apply the `Heading 1` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_h1 = { element: 'h1', attributes: { 'class': 'contentTitle1' } };
*
* @cfg {Object} [format_h1={ element: 'h1' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_h1 = { element: "h1" };
/**
* The style definition to be used to apply the `Heading 2` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_h2 = { element: 'h2', attributes: { 'class': 'contentTitle2' } };
*
* @cfg {Object} [format_h2={ element: 'h2' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_h2 = { element: "h2" };
/**
* The style definition to be used to apply the `Heading 3` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_h3 = { element: 'h3', attributes: { 'class': 'contentTitle3' } };
*
* @cfg {Object} [format_h3={ element: 'h3' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_h3 = { element: "h3" };
/**
* The style definition to be used to apply the `Heading 4` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_h4 = { element: 'h4', attributes: { 'class': 'contentTitle4' } };
*
* @cfg {Object} [format_h4={ element: 'h4' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_h4 = { element: "h4" };
/**
* The style definition to be used to apply the `Heading 5` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_h5 = { element: 'h5', attributes: { 'class': 'contentTitle5' } };
*
* @cfg {Object} [format_h5={ element: 'h5' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_h5 = { element: "h5" };
/**
* The style definition to be used to apply the `Heading 6` format.
*
* Read more in the {@glink features/format documentation}
* and see the {@glink examples/format example}.
*
* config.format_h6 = { element: 'h6', attributes: { 'class': 'contentTitle6' } };
*
* @cfg {Object} [format_h6={ element: 'h6' }]
* @member CKEDITOR.config
*/
CKEDITOR.config.format_h6 = { element: "h6" };