2 Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
7 * @fileOverview The "elementspath" plugin. It shows all elements in the DOM
\r
8 * parent tree relative to the current selection in the editing area.
\r
17 editorFocus : false,
\r
19 exec : function( editor )
\r
21 var idBase = editor._.elementsPath.idBase;
\r
22 var element = CKEDITOR.document.getById( idBase + '0' );
\r
24 // Make the first button focus accessible for IE. (#3417)
\r
25 // Adobe AIR instead need while of delay.
\r
26 element && element.focus( CKEDITOR.env.ie || CKEDITOR.env.air );
\r
31 var emptyHtml = '<span class="cke_empty"> </span>';
\r
33 CKEDITOR.plugins.add( 'elementspath',
\r
35 requires : [ 'selection' ],
\r
37 init : function( editor )
\r
39 var spaceId = 'cke_path_' + editor.name;
\r
41 var getSpaceElement = function()
\r
43 if ( !spaceElement )
\r
44 spaceElement = CKEDITOR.document.getById( spaceId );
\r
45 return spaceElement;
\r
48 var idBase = 'cke_elementspath_' + CKEDITOR.tools.getNextNumber() + '_';
\r
50 editor._.elementsPath = { idBase : idBase, filters : [] };
\r
52 editor.on( 'themeSpace', function( event )
\r
54 if ( event.data.space == 'bottom' )
\r
57 '<span id="' + spaceId + '_label" class="cke_voice_label">' + editor.lang.elementsPath.eleLabel + '</span>' +
\r
58 '<div id="' + spaceId + '" class="cke_path" role="group" aria-labelledby="' + spaceId + '_label">' + emptyHtml + '</div>';
\r
62 function onClick( elementIndex )
\r
65 var element = editor._.elementsPath.list[ elementIndex ];
\r
66 if ( element.is( 'body' ) )
\r
68 var range = new CKEDITOR.dom.range( editor.document );
\r
69 range.selectNodeContents( element );
\r
73 editor.getSelection().selectElement( element );
\r
76 var onClickHanlder = CKEDITOR.tools.addFunction( onClick );
\r
78 var onKeyDownHandler = CKEDITOR.tools.addFunction( function( elementIndex, ev )
\r
80 var idBase = editor._.elementsPath.idBase,
\r
83 ev = new CKEDITOR.dom.event( ev );
\r
85 var rtl = editor.lang.dir == 'rtl';
\r
86 switch ( ev.getKeystroke() )
\r
88 case rtl ? 39 : 37 : // LEFT-ARROW
\r
90 element = CKEDITOR.document.getById( idBase + ( elementIndex + 1 ) );
\r
92 element = CKEDITOR.document.getById( idBase + '0' );
\r
96 case rtl ? 37 : 39 : // RIGHT-ARROW
\r
97 case CKEDITOR.SHIFT + 9 : // SHIFT + TAB
\r
98 element = CKEDITOR.document.getById( idBase + ( elementIndex - 1 ) );
\r
100 element = CKEDITOR.document.getById( idBase + ( editor._.elementsPath.list.length - 1 ) );
\r
108 case 13 : // ENTER // Opera
\r
110 onClick( elementIndex );
\r
116 editor.on( 'selectionChange', function( ev )
\r
118 var env = CKEDITOR.env,
\r
119 selection = ev.data.selection,
\r
120 element = selection.getStartElement(),
\r
122 editor = ev.editor,
\r
123 elementsList = editor._.elementsPath.list = [],
\r
124 filters = editor._.elementsPath.filters;
\r
131 if ( element.data( 'cke-display-name' ) )
\r
132 name = element.data( 'cke-display-name' );
\r
133 else if ( element.data( 'cke-real-element-type' ) )
\r
134 name = element.data( 'cke-real-element-type' );
\r
136 name = element.getName();
\r
138 for ( var i = 0; i < filters.length; i++ )
\r
140 var ret = filters[ i ]( element, name );
\r
141 if ( ret === false )
\r
146 name = ret || name;
\r
151 var index = elementsList.push( element ) - 1;
\r
153 // Use this variable to add conditional stuff to the
\r
154 // HTML (because we are doing it in reverse order... unshift).
\r
157 // Some browsers don't cancel key events in the keydown but in the
\r
159 // TODO: Check if really needed for Gecko+Mac.
\r
160 if ( env.opera || ( env.gecko && env.mac ) )
\r
161 extra += ' onkeypress="return false;"';
\r
163 // With Firefox, we need to force the button to redraw, otherwise it
\r
164 // will remain in the focus state.
\r
166 extra += ' onblur="this.style.cssText = this.style.cssText;"';
\r
168 var label = editor.lang.elementsPath.eleTitle.replace( /%1/, name );
\r
171 ' id="', idBase, index, '"' +
\r
172 ' href="javascript:void(\'', name, '\')"' +
\r
174 ' title="', label, '"' +
\r
175 ( ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 ) ?
\r
176 ' onfocus="event.preventBubble();"' : '' ) +
\r
177 ' hidefocus="true" ' +
\r
178 ' onkeydown="return CKEDITOR.tools.callFunction(', onKeyDownHandler, ',', index, ', event );"' +
\r
180 ' onclick="CKEDITOR.tools.callFunction('+ onClickHanlder, ',', index, '); return false;"',
\r
181 ' role="button" aria-labelledby="' + idBase + index + '_label">',
\r
183 '<span id="', idBase, index, '_label" class="cke_label">' + label + '</span>',
\r
188 if ( name == 'body' )
\r
191 element = element.getParent();
\r
194 var space = getSpaceElement();
\r
195 space.setHtml( html.join('') + emptyHtml );
\r
196 editor.fire( 'elementsPathUpdate', { space : space } );
\r
201 spaceElement && spaceElement.setHtml( emptyHtml );
\r
202 delete editor._.elementsPath.list;
\r
205 editor.on( 'readOnly', empty );
\r
206 editor.on( 'contentDomUnload', empty );
\r
208 editor.addCommand( 'elementsPathFocus', commands.toolbarFocus );
\r
214 * Fired when the contents of the elementsPath are changed
\r
215 * @name CKEDITOR.editor#elementsPathUpdate
\r
217 * @param {Object} eventData.space The elementsPath container
\r