summaryrefslogtreecommitdiff
path: root/_source/plugins/devtools/plugin.js
diff options
context:
space:
mode:
authorlsces <lester@lsces.co.uk>2012-06-10 19:03:48 +0100
committerlsces <lester@lsces.co.uk>2012-06-10 19:03:48 +0100
commitf3ce03a71d3dd1c7dcbe474197fb1588949735db (patch)
tree7c31cd62ef0e2790966f96498e553f22fa4e08d3 /_source/plugins/devtools/plugin.js
parent23b8cf2a890c7de389616702fd23c9c465311a59 (diff)
downloadckeditor-f3ce03a71d3dd1c7dcbe474197fb1588949735db.tar.gz
ckeditor-f3ce03a71d3dd1c7dcbe474197fb1588949735db.tar.bz2
ckeditor-f3ce03a71d3dd1c7dcbe474197fb1588949735db.zip
Update to CKEditor version 3.6.3
Diffstat (limited to '_source/plugins/devtools/plugin.js')
-rw-r--r--_source/plugins/devtools/plugin.js173
1 files changed, 173 insertions, 0 deletions
diff --git a/_source/plugins/devtools/plugin.js b/_source/plugins/devtools/plugin.js
new file mode 100644
index 0000000..255b1c3
--- /dev/null
+++ b/_source/plugins/devtools/plugin.js
@@ -0,0 +1,173 @@
+/*
+Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+CKEDITOR.plugins.add( 'devtools',
+{
+ lang : [ 'bg', 'cs', 'cy', 'da', 'de', 'el', 'en', 'eo', 'et', 'fa', 'fi', 'fr', 'gu', 'he', 'hr', 'it', 'nb', 'nl', 'no', 'pl', 'tr', 'ug', 'uk', 'vi', 'zh-cn' ],
+
+ init : function( editor )
+ {
+ editor._.showDialogDefinitionTooltips = 1;
+ },
+ onLoad : function()
+ {
+ CKEDITOR.document.appendStyleText( CKEDITOR.config.devtools_styles ||
+ '#cke_tooltip { padding: 5px; border: 2px solid #333; background: #ffffff }' +
+ '#cke_tooltip h2 { font-size: 1.1em; border-bottom: 1px solid; margin: 0; padding: 1px; }' +
+ '#cke_tooltip ul { padding: 0pt; list-style-type: none; }' );
+ }
+});
+
+(function()
+{
+ function defaultCallback( editor, dialog, element, tabName )
+ {
+ var lang = editor.lang.devTools,
+ link = '<a href="http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.dialog.definition.' +
+ ( element ? ( element.type == 'text' ? 'textInput' : element.type ) : 'content' ) +
+ '.html" target="_blank">' + ( element ? element.type : 'content' ) + '</a>',
+ str =
+ '<h2>' + lang.title + '</h2>' +
+ '<ul>' +
+ '<li><strong>' + lang.dialogName + '</strong> : ' + dialog.getName() + '</li>' +
+ '<li><strong>' + lang.tabName + '</strong> : ' + tabName + '</li>';
+
+ if ( element )
+ str += '<li><strong>' + lang.elementId + '</strong> : ' + element.id + '</li>';
+
+ str += '<li><strong>' + lang.elementType + '</strong> : ' + link + '</li>';
+
+ return str + '</ul>';
+ }
+
+ function showTooltip( callback, el, editor, dialog, obj, tabName )
+ {
+ var pos = el.getDocumentPosition(),
+ styles = { 'z-index' : CKEDITOR.dialog._.currentZIndex + 10, top : ( pos.y + el.getSize( 'height' ) ) + 'px' };
+
+ tooltip.setHtml( callback( editor, dialog, obj, tabName ) );
+ tooltip.show();
+
+ // Translate coordinate for RTL.
+ if ( editor.lang.dir == 'rtl' )
+ {
+ var viewPaneSize = CKEDITOR.document.getWindow().getViewPaneSize();
+ styles.right = ( viewPaneSize.width - pos.x - el.getSize( 'width' ) ) + 'px';
+ }
+ else
+ styles.left = pos.x + 'px';
+
+ tooltip.setStyles( styles );
+ }
+
+ var tooltip;
+ CKEDITOR.on( 'reset', function()
+ {
+ tooltip && tooltip.remove();
+ tooltip = null;
+ });
+
+ CKEDITOR.on( 'dialogDefinition', function( evt )
+ {
+ var editor = evt.editor;
+ if ( editor._.showDialogDefinitionTooltips )
+ {
+ if ( !tooltip )
+ {
+ tooltip = CKEDITOR.dom.element.createFromHtml( '<div id="cke_tooltip" tabindex="-1" style="position: absolute"></div>', CKEDITOR.document );
+ tooltip.hide();
+ tooltip.on( 'mouseover', function(){ this.show(); } );
+ tooltip.on( 'mouseout', function(){ this.hide(); } );
+ tooltip.appendTo( CKEDITOR.document.getBody() );
+ }
+
+ var dialog = evt.data.definition.dialog,
+ callback = editor.config.devtools_textCallback || defaultCallback;
+
+ dialog.on( 'load', function()
+ {
+ var tabs = dialog.parts.tabs.getChildren(), tab;
+ for ( var i = 0, len = tabs.count(); i < len; i++ )
+ {
+ tab = tabs.getItem( i );
+ tab.on( 'mouseover', function()
+ {
+ var id = this.$.id;
+ showTooltip( callback, this, editor, dialog, null, id.substring( 4, id.lastIndexOf( '_' ) ) );
+ });
+ tab.on( 'mouseout', function()
+ {
+ tooltip.hide();
+ });
+ }
+
+ dialog.foreach( function( obj )
+ {
+ if ( obj.type in { hbox : 1, vbox : 1 } )
+ return;
+
+ var el = obj.getElement();
+ if ( el )
+ {
+ el.on( 'mouseover', function()
+ {
+ showTooltip( callback, this, editor, dialog, obj, dialog._.currentTabId );
+ });
+ el.on( 'mouseout', function()
+ {
+ tooltip.hide();
+ });
+ }
+ });
+ });
+ }
+ });
+})();
+
+/**
+ * A function that returns the text to be displayed inside the Developer Tools tooltip when hovering over a dialog UI element.
+ * There are 4 parameters that are being passed into the function: editor, dialog window, element, tab name.
+ * @name editor.config.devtools_textCallback
+ * @since 3.6
+ * @type Function
+ * @default (see example)
+ * @example
+ * // This is actually the default value.
+ * // Show dialog window name, tab ID, and element ID.
+ * config.devtools_textCallback = function( editor, dialog, element, tabName )
+ * {
+ * var lang = editor.lang.devTools,
+ * link = '<a href="http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.dialog.definition.' +
+ * ( element ? ( element.type == 'text' ? 'textInput' : element.type ) : 'content' ) +
+ * '.html" target="_blank">' + ( element ? element.type : 'content' ) + '</a>',
+ * str =
+ * '<h2>' + lang.title + '</h2>' +
+ * '<ul>' +
+ * '<li><strong>' + lang.dialogName + '</strong> : ' + dialog.getName() + '</li>' +
+ * '<li><strong>' + lang.tabName + '</strong> : ' + tabName + '</li>';
+ *
+ * if ( element )
+ * str += '<li><strong>' + lang.elementId + '</strong> : ' + element.id + '</li>';
+ *
+ * str += '<li><strong>' + lang.elementType + '</strong> : ' + link + '</li>';
+ *
+ * return str + '</ul>';
+ * }
+ */
+
+/**
+ * A setting that stores CSS rules to be injected into the page with styles to be applied to the tooltip element.
+ * @name CKEDITOR.config.devtools_styles
+ * @since 3.6
+ * @type String
+ * @default (see example)
+ * @example
+ * // This is actually the default value.
+ * CKEDITOR.config.devtools_styles = &quot;
+ * #cke_tooltip { padding: 5px; border: 2px solid #333; background: #ffffff }
+ * #cke_tooltip h2 { font-size: 1.1em; border-bottom: 1px solid; margin: 0; padding: 1px; }
+ * #cke_tooltip ul { padding: 0pt; list-style-type: none; }
+ * &quot;;
+ */