Implement Split File Editor Functionality for the Eclipse IDE

From Eclipsepedia

Jump to: navigation, search

Contents

Releases

Instructions: Click on the link to download the JAR file and place it in the dropins directory of Eclipse
Requirements: Eclipse 3.4 RC4 or later

  • 2007-07-14. Working universal split editor prototype (MultiEditor-based). Ctrl-6 to split any editor.
  • 2008-06-30. Split editor with basic functionality (undo/redo, cut/copy/paste, cursor line highlight, action contributions to menu/toolbar/statusbar) working correctly.
  • 2008-06-23. 1st release of multi editor and split editor implementations. Instructions: Download the plugin jar and place in the dropins directory (compatible with Eclipse 3.4 RC4 or later).

Project Completion Plan

Legend

Image:Glass.gif Pending item/not started
Image:Progress.gif Work in progress
Image:Ok_green.gif Bug fixed / Feature added

Milestone Deadline Tasks
M1 July 21, 2008

Image:Ok_green.gif MultiEditor backwards compatibility
Image:Ok_green.gif Fix activation warnings
Image:Ok_green.gif AbstractMultiEditor patch for bug 240651

M2 July 28, 2008

Image:Ok_green.gif AbstractMultiEditor API for dynamic addition/removal of InnerEditors
Image:Progress.gif Design and implement a procedure for enabling split editing support in existing and new editors
Image:Progress.gif SplitMultiEditor persistence between sessions

RC1 August 4, 2008

Image:Glass.gif Look into participation in the SoC Simultaneous Release
Image:Glass.gif Java breadcrumb clicking problem
Image:Glass.gif Comprehensive testing and fixing of new issues

RC2 August 11, 2008

Image:Glass.gif Go over Daniel's List of MultiEditor-related bugs and fix or comment where appropriate.
Image:Glass.gif Fix other related bugs such as 64911 if time permits

Final August 18, 2008

Image:Glass.gif Fix any critical coding issues only
Image:Glass.gif Documentation and final integration work

Implementations

Multi Editor-based

Usage: Open a file in Eclipse, then select Window -> New Split Editor from the main menu to open a split editor of the file.

This implementation is based on Paul Webster's patch, which uses the existing multi-editor architecture in Eclipse.

  • Advantages
    • does not require custom work for different editor types (java/xml/etc)
    • works automatically with new custom editor types
  • Disadvantages
    • Split editor opens in a new tab as opposed to appearing within the existing tab
    • Activating with the mouse requires going to the main menu (Window->New Split Editor). There is also a keyboard shortcut - Ctrl+6.
    • Bound by the limitations of the multi-editor infrastructure

Custom Split Editor Implementation

Usage: Right-click on a file, select Open with -> Other... and select \[Split Text Editor\] from the list of editors.

This implementation is based on a custom editor implementation that dynamically creates a new StyledText control when a sash is dragged within the editor to split it.

  • Advantages
    • fully replaces existing editors and allows splitting the active editor in-place (as opposed to opening a split editor in a new tab)
    • easier activation via the mouse because there is no need to go to the window main menu or editor tab context menu.
  • Disadvantages
    • requires customization of every editor class that wants to support split editing (java/xml... etc)

Issue Tracker

Legend

Image:Glass.gif Needs some investigation/research
Image:Progress.gif Work in progress
Image:Ok_green.gif Bug fixed / Feature added

Uncategorized

Feature Importance Test Case Multi Editor Split Editor New Editor Tab
Delete open file critical Delete file from the package explorer while the file is open in a split editor Image:Ok_green.gif fixed
does not work - memory leak keeps nonexistent resource in package explorer 		not tested works
Java Breadcrumb click critical Click on the leaf element of the java breadcrumb in one editor then the other and go back and forth several times. Image:Glass.gif does not work - SWT exception is thrown. seems to be related to general problem with multieditor activation not tested works
Save critical Select File-> Save from the main menu Image:Ok_green.gif fixed
works but invokes Save command twice 		Image:Ok_green.gif works works
Save as critical Select File-> Save As from the main menu Image:Ok_green.gif fixed
works but the other nested editor is not switched to the new resource 		Image:Ok_green.gif works works
Mark dirty editor's tab (star (*) next to file name) critical Make a change in the editor Image:Ok_green.gif fixed
does not mark editor tab as dirty with a * (star) 		Image:Ok_green.gif works works
Mark occurrences (java) nice-to-have enable mark occurrences and click over a java element (method/field/class name etc) works but marks occurrences in both editors Image:Glass.gif not applicable (java editor not available) works but marks occurrences in both editors
Mark occurrences of different elements (java) nice-to-have enable mark occurrences and click over different java elements in both editors works but both elements are highlighted in both editors Image:Glass.gif not applicable (java editor not available) works but both elements are highlighted in both editors (see bug 64911)
Current line highlight within active focused editor critical switch the focus (by mouse-clicking) between the two editors Image:Ok_green.gif works Image:Ok_green.gif fixed
does not appear in top editor and cursor is no longer visible in bottom editor after split 		works
Back/Forward Navigation (Navigate->Back/Forward from menu or Alt-Left/Right Arrow keys) nice-to-have click within the one of the two editors; make a change; switch to another editor; use Go Back command (Alt-LeftArrow) to go back does not always go back to the editor where the change was made does not always go back to the editor where the change was made does not always go back to the editor where the change was made
Moving around text using Ctrl-? key commands critical Use Ctrl+Home/End to move to the beginning/end of the editor; Ctrl+Left/Right to move left/right a word at a time; Ctrl+Shift+Left/Right to move and left/right a word at a time and expand the selection Image:Ok_green.gif works Image:Ok_green.gif fixed
always acts on top editor in split mode, regardless of which editor (top or bottom) the cursor is in 		works
Undo/Redo from menu critical open a split editor or multiple editor tabs, type some text in one of the editors and select Edit->Undo from the menu Image:Ok_green.gif works Image:Ok_green.gif works works
Undo/Redo using keyboard critical open a split editor or multiple editor tabs, type some text in one of the editors and type Ctrl-Z to undo then Ctrl-Y to redo Image:Ok_green.gif works Image:Ok_green.gif works works
Cut/Copy/Paste from menu critical open a split editor or multiple editor tabs, select some text in one of the editors and select Edit->Cut from the menu, then Edit->Paste Image:Ok_green.gif works Image:Ok_green.gif works works
Cut/Copy/Paste using keyboard critical open a split editor or multiple editor tabs, select some text in one of the editors and type Ctrl-X to cut, then Ctrl-V to paste Image:Ok_green.gif works Image:Ok_green.gif works works
Quick-fix shortcut critical press Ctrl-1 where a quick-fix is available (misspelled word for example); check at different locations in both editors Image:Ok_green.gif works Image:Ok_green.gif works works
Incremental find critical press Ctrl-J then type some text to look for Image:Ok_green.gif works Image:Ok_green.gif works works
Find Next/Previous shortcuts critical press Ctrl-K; Ctrl-Shift-K to find the next/previous occurrence of the selected text Image:Ok_green.gif works Image:Ok_green.gif works works
Find Next/Previous from menu critical use Edit->Find Next/Previous from menu Image:Ok_green.gif works Image:Ok_green.gif works works
Go to line action critical Select Navigate-> Go to line... from the menu; type a line that would require the active editor to be scrolled to bring into view Image:Ok_green.gif works Image:Ok_green.gif works works
Overview Ruler context menu critical right click on the overview ruler (to the right of vertical scrollbar) Image:Ok_green.gif works Image:Ok_green.gif works works
Vertical Ruler context menu critical right click on the vertical ruler (to the left of editor) after splitting in either editor Image:Ok_green.gif works Image:Glass.gif does not work after splitting several times - the context menu stops showing on right-click works
Show whitespace characters toggle critical customize perspective and make sure the Editor Presentations command group is checked under the Commands tab. Open Split editor and press the toggle white-space toolbar button Image:Ok_green.gif works Image:Glass.gif only updates the active editor works
Default (non-accessible) caret important Uncheck the "use custom caret" option from the Accessibility preference panel Image:Ok_green.gif works Image:Glass.gif the caret no longer shows in the slave editor works
Text editor font change important Change the Text Font from the Colors and Fonts preference panel Image:Ok_green.gif works Image:Glass.gif the font of the active editor only is updated works

Preferences

When preferences that are related to editor appearance or behavior are updated, a split editor needs to propagate the changes to both of its internal editors. Here is a comprehensive list of text editor preferences and the corresponding split editor behavior on preference change.

Preference Page Preference Key Editor Class Are both editors updated?
Appearance color optionsGeneral->Editors->Text EditorsPREFERENCE_COLOR_*AbstractTextEditorImage:Progress.gif no
Use custom caretGeneral->Editors->Text Editors->AccessibilityPREFERENCE_USE_CUSTOM_CARETSAbstractTextEditorImage:Progress.gif no
Enable thick caretGeneral->Editors->Text Editors->AccessibilityPREFERENCE_WIDE_CARETAbstractTextEditorImage:Ok_green.gif yes
Enable on demand hyperlink…General->Editors->Text Editors->HyperlinkingPREFERENCE_HYPERLINKS_ENABLEDAbstractTextEditorImage:Glass.gif not testable on plain text editor
Default modifier keyGeneral->Editors->Text Editors->HyperlinkingPREFERENCE_HYPERLINK_KEY_MODIFIERAbstractTextEditorImage:Glass.gif not testable on plain text editor
Image:Glass.gif Image:Glass.gif PREFERENCE_RULER_CONTRIBUTIONSAbstractTextEditorImage:Glass.gif pref page not found
Show whitespace charactersGeneral->Editors->Text EditorsPREFERENCE_SHOW_WHITESPACE_CHARACTERSAbstractTextEditorImage:Progress.gif no
Enable drag and drop of textGeneral->Editors->Text EditorsPREFERENCE_TEXT_DRAG_AND_DROP_ENABLEDAbstractTextEditorImage:Progress.gif no
When mouse moved into hover…General->Editors->Text EditorsPREFERENCE_HOVER_ENRICH_MODEAbstractTextEditorImage:Progress.gif no
Image:Glass.gif Image:Glass.gif OVERVIEW_RULERAbstractDecoratedTextEditorImage:Glass.gif pref page not found
Image:Glass.gif Image:Glass.gif DISABLE_OVERWRITE_MODEAbstractDecoratedTextEditorImage:Glass.gif pref page not found
Show line numbersGeneral->Editors->Text EditorsLINE_NUMBER_RULERAbstractDecoratedTextEditorImage:Ok_green.gif yes
Enable quick diffGeneral->Editors->Text Editors->Quick DiffQUICK_DIFF_ALWAYS_ONAbstractDecoratedTextEditorImage:Ok_green.gif yes
Show differences in overview rulerGeneral->Editors->Text Editors->Quick DiffImage:Glass.gif Image:Glass.gif Image:Ok_green.gif yes
ColorsGeneral->Editors->Text Editors->Quick DiffImage:Glass.gif Image:Glass.gif Image:Progress.gif EXCEPTION, but works
Displayed tab widthGeneral->Editors->Text EditorsEDITOR_TAB_WIDTHAbstractDecoratedTextEditorno
Insert spaces for tabsGeneral->Editors->Text EditorsEDITOR_SPACES_FOR_TABSAbstractDecoratedTextEditorno
Undo history sizeGeneral->Editors->Text EditorsEDITOR_UNDO_HISTORY_SIZEAbstractDecoratedTextEditorImage:Glass.gif not tested
Show range indicatorGeneral->Editors->Text EditorsSHOW_RANGE_INDICATORAbstractDecoratedTextEditorImage:Glass.gif what is range indication
Enable spell checkingGeneral->Editors->Text Editors->SpellingPREFERENCE_SPELLING_ENABLEDTextEditorImage:Ok_green.gif yes
Highlight current lineGeneral->Editors->Text EditorsImage:Glass.gif Image:Glass.gif Image:Progress.gif EXCEPTION when turning on, but works
Show print marginGeneral->Editors->Text EditorsImage:Glass.gif Image:Glass.gif Image:Progress.gif EXCEPTION
Smart caret positioning at line start and endGeneral->Editors->Text EditorsImage:Glass.gif Image:Glass.gif Image:Progress.gif no
(all) General->Editors->Text Editors->Linked ModeImage:Glass.gif Image:Glass.gif Image:Glass.gif not tested
Vertical rulerGeneral->Editors->Text Editors->AnnotationsImage:Glass.gif Image:Glass.gif Image:Ok_green.gif yes
Overview rulerGeneral->Editors->Text Editors->AnnotationsImage:Glass.gif Image:Glass.gif Image:Ok_green.gif yes
Text asGeneral->Editors->Text Editors->AnnotationsImage:Glass.gif Image:Glass.gif Image:Progress.gif EXCEPTION, but works
ColorGeneral->Editors->Text Editors->AnnotationsImage:Glass.gif Image:Glass.gif Image:Progress.gif EXCEPTION, but works

Editor Actions

TODO

Retrieved from "http://wiki.eclipse.org/Implement_Split_File_Editor_Functionality_for_the_Eclipse_IDE"

Copyright © 2009 The Eclipse Foundation. All Rights Reserved

  • This page was last modified 10:08, 23 July 2008 by Nikolay Botev.
Personal tools