Difference between revisions of "Implement Split File Editor Functionality for the Eclipse IDE"

From Eclipsepedia

Jump to: navigation, search
(Issue Tracker)
m (Preferences)
Line 220: Line 220:
 
| align="center" style="background:#f0f0f0;"|'''Preference Key'''
 
| align="center" style="background:#f0f0f0;"|'''Preference Key'''
 
| align="center" style="background:#f0f0f0;"|'''Editor Class'''
 
| align="center" style="background:#f0f0f0;"|'''Editor Class'''
| align="center" style="background:#f0f0f0;"|'''both editors updated[[Image:Glass.gif]]'''
+
| align="center" style="background:#f0f0f0;"|'''both editors updated[[Image:Glass.gif]] '''
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Appearance color options||General->Editors->Text Editors||PREFERENCE_COLOR_[[Image:Progress.gif]]||AbstractTextEditor||[[Image:Progress.gif]]no
+
| Appearance color options||General->Editors->Text Editors||PREFERENCE_COLOR_[[Image:Progress.gif]] ||AbstractTextEditor||[[Image:Progress.gif]] no
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Use custom caret||General->Editors->Text Editors->Accessibility||PREFERENCE_USE_CUSTOM_CARETS||AbstractTextEditor||[[Image:Progress.gif]]no
+
| Use custom caret||General->Editors->Text Editors->Accessibility||PREFERENCE_USE_CUSTOM_CARETS||AbstractTextEditor||[[Image:Progress.gif]] no
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
 
| Enable thick caret||General->Editors->Text Editors->Accessibility||PREFERENCE_WIDE_CARET||AbstractTextEditor||[[Image:Ok_green.gif]] yes
 
| Enable thick caret||General->Editors->Text Editors->Accessibility||PREFERENCE_WIDE_CARET||AbstractTextEditor||[[Image:Ok_green.gif]] yes
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Enable on demand hyperlink…||General->Editors->Text Editors->Hyperlinking||PREFERENCE_HYPERLINKS_ENABLED||AbstractTextEditor||[[Image:Glass.gif]]not testable on plain text editor
+
| Enable on demand hyperlink…||General->Editors->Text Editors->Hyperlinking||PREFERENCE_HYPERLINKS_ENABLED||AbstractTextEditor||[[Image:Glass.gif]] not testable on plain text editor
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Default modifier key||General->Editors->Text Editors->Hyperlinking||PREFERENCE_HYPERLINK_KEY_MODIFIER||AbstractTextEditor||[[Image:Glass.gif]]not testable on plain text editor
+
| Default modifier key||General->Editors->Text Editors->Hyperlinking||PREFERENCE_HYPERLINK_KEY_MODIFIER||AbstractTextEditor||[[Image:Glass.gif]] not testable on plain text editor
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| [[Image:Glass.gif]]||[[Image:Glass.gif]]||PREFERENCE_RULER_CONTRIBUTIONS||AbstractTextEditor||[[Image:Glass.gif]]pref page not found
+
| [[Image:Glass.gif]] ||[[Image:Glass.gif]] ||PREFERENCE_RULER_CONTRIBUTIONS||AbstractTextEditor||[[Image:Glass.gif]] pref page not found
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Show whitespace characters||General->Editors->Text Editors||PREFERENCE_SHOW_WHITESPACE_CHARACTERS||AbstractTextEditor||[[Image:Progress.gif]]no
+
| Show whitespace characters||General->Editors->Text Editors||PREFERENCE_SHOW_WHITESPACE_CHARACTERS||AbstractTextEditor||[[Image:Progress.gif]] no
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Enable drag and drop of text||General->Editors->Text Editors||PREFERENCE_TEXT_DRAG_AND_DROP_ENABLED||AbstractTextEditor||[[Image:Progress.gif]]no
+
| Enable drag and drop of text||General->Editors->Text Editors||PREFERENCE_TEXT_DRAG_AND_DROP_ENABLED||AbstractTextEditor||[[Image:Progress.gif]] no
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| When mouse moved into hover…||General->Editors->Text Editors||PREFERENCE_HOVER_ENRICH_MODE||AbstractTextEditor||[[Image:Progress.gif]]no
+
| When mouse moved into hover…||General->Editors->Text Editors||PREFERENCE_HOVER_ENRICH_MODE||AbstractTextEditor||[[Image:Progress.gif]] no
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| [[Image:Glass.gif]]||[[Image:Glass.gif]]||OVERVIEW_RULER||AbstractDecoratedTextEditor||[[Image:Glass.gif]]pref page not found
+
| [[Image:Glass.gif]] ||[[Image:Glass.gif]] ||OVERVIEW_RULER||AbstractDecoratedTextEditor||[[Image:Glass.gif]] pref page not found
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| [[Image:Glass.gif]]||[[Image:Glass.gif]]||DISABLE_OVERWRITE_MODE||AbstractDecoratedTextEditor||[[Image:Glass.gif]]pref page not found
+
| [[Image:Glass.gif]] ||[[Image:Glass.gif]] ||DISABLE_OVERWRITE_MODE||AbstractDecoratedTextEditor||[[Image:Glass.gif]] pref page not found
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
 
| Show line numbers||General->Editors->Text Editors||LINE_NUMBER_RULER||AbstractDecoratedTextEditor||[[Image:Ok_green.gif]] yes
 
| Show line numbers||General->Editors->Text Editors||LINE_NUMBER_RULER||AbstractDecoratedTextEditor||[[Image:Ok_green.gif]] yes
Line 248: Line 248:
 
| Enable quick diff||General->Editors->Text Editors->Quick Diff||QUICK_DIFF_ALWAYS_ON||AbstractDecoratedTextEditor||[[Image:Ok_green.gif]] yes
 
| Enable quick diff||General->Editors->Text Editors->Quick Diff||QUICK_DIFF_ALWAYS_ON||AbstractDecoratedTextEditor||[[Image:Ok_green.gif]] yes
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Show differences in overview ruler||General->Editors->Text Editors->Quick Diff||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Ok_green.gif]] yes
+
| Show differences in overview ruler||General->Editors->Text Editors->Quick Diff||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Ok_green.gif]] yes
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Colors||General->Editors->Text Editors->Quick Diff||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Progress.gif]]EXCEPTION, but works
+
| Colors||General->Editors->Text Editors->Quick Diff||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Progress.gif]] EXCEPTION, but works
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
 
| Displayed tab width||General->Editors->Text Editors||EDITOR_TAB_WIDTH||AbstractDecoratedTextEditor||no
 
| Displayed tab width||General->Editors->Text Editors||EDITOR_TAB_WIDTH||AbstractDecoratedTextEditor||no
Line 256: Line 256:
 
| Insert spaces for tabs||General->Editors->Text Editors||EDITOR_SPACES_FOR_TABS||AbstractDecoratedTextEditor||no
 
| Insert spaces for tabs||General->Editors->Text Editors||EDITOR_SPACES_FOR_TABS||AbstractDecoratedTextEditor||no
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Undo history size||General->Editors->Text Editors||EDITOR_UNDO_HISTORY_SIZE||AbstractDecoratedTextEditor||[[Image:Glass.gif]]not tested
+
| Undo history size||General->Editors->Text Editors||EDITOR_UNDO_HISTORY_SIZE||AbstractDecoratedTextEditor||[[Image:Glass.gif]] not tested
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Show range indicator||General->Editors->Text Editors||SHOW_RANGE_INDICATOR||AbstractDecoratedTextEditor||[[Image:Glass.gif]]what is range indication
+
| Show range indicator||General->Editors->Text Editors||SHOW_RANGE_INDICATOR||AbstractDecoratedTextEditor||[[Image:Glass.gif]] what is range indication
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
 
| Enable spell checking||General->Editors->Text Editors->Spelling||PREFERENCE_SPELLING_ENABLED||TextEditor||[[Image:Ok_green.gif]] yes
 
| Enable spell checking||General->Editors->Text Editors->Spelling||PREFERENCE_SPELLING_ENABLED||TextEditor||[[Image:Ok_green.gif]] yes
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Highlight current line||General->Editors->Text Editors||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Progress.gif]]EXCEPTION when turning on, but works
+
| Highlight current line||General->Editors->Text Editors||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Progress.gif]] EXCEPTION when turning on, but works
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Show print margin||General->Editors->Text Editors||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Progress.gif]]EXCEPTION
+
| Show print margin||General->Editors->Text Editors||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Progress.gif]] EXCEPTION
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Smart caret positioning at line start and end||General->Editors->Text Editors||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Progress.gif]]no
+
| Smart caret positioning at line start and end||General->Editors->Text Editors||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Progress.gif]] no
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| [[Image:Progress.gif]]||General->Editors->Text Editors->Linked Mode||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Glass.gif]]not tested
+
| [[Image:Progress.gif]] ||General->Editors->Text Editors->Linked Mode||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Glass.gif]] not tested
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Vertical ruler||General->Editors->Text Editors->Annotations||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Ok_green.gif]] yes
+
| Vertical ruler||General->Editors->Text Editors->Annotations||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Ok_green.gif]] yes
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Overview ruler||General->Editors->Text Editors->Annotations||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Ok_green.gif]] yes
+
| Overview ruler||General->Editors->Text Editors->Annotations||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Ok_green.gif]] yes
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Text as||General->Editors->Text Editors->Annotations||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Progress.gif]]EXCEPTION, but works
+
| Text as||General->Editors->Text Editors->Annotations||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Progress.gif]] EXCEPTION, but works
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
| Color||General->Editors->Text Editors->Annotations||[[Image:Glass.gif]]||[[Image:Glass.gif]]||[[Image:Progress.gif]]EXCEPTION, but works
+
| Color||General->Editors->Text Editors->Annotations||[[Image:Glass.gif]] ||[[Image:Glass.gif]] ||[[Image:Progress.gif]] EXCEPTION, but works
 
|- style="background:lightgrey;"
 
|- style="background:lightgrey;"
 
|  
 
|  
 
|}
 
|}

Revision as of 05:51, 3 July 2008

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

  • 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).

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

Glass.gif Needs some investigation/research
Progress.gif Work in progress
Ok green.gif Bug fixed / Feature added

Uncategorized

Feature Importance Test Case Multi Editor Split Editor New Editor Tab
Save critical Select File-> Save from the main menu works but invokes Save command twice Ok green.gif works works
Save as critical Select File-> Save As from the main menu does not work Ok green.gif works works
Mark dirty editor's tab (star (*) next to file name) critical Make a change in the editor does not mark editor tab as dirty with a * (star) 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 Glass.gif not applicable (java editor not available) works
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 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 works 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 not tested 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 not tested 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 not tested 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 not tested 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 not tested 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 not tested Ok green.gif works works
Incremental find critical press Ctrl-J then type some text to look for not tested 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 not tested Ok green.gif works works
Find Next/Previous from menu critical use Edit->Find Next/Previous from menu not tested 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 not tested Ok green.gif works works
Overview Ruler context menu critical right click on the overview ruler (to the right of vertical scrollbar) not tested 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 not tested 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 not tested Glass.gif only updates the active editor works
Default (non-accessible) caret important Uncheck the "use custom caret" option from the Accessibility preference panel not tested 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 not tested 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 both editors updatedGlass.gif
Appearance color options General->Editors->Text Editors PREFERENCE_COLOR_Progress.gif AbstractTextEditor Progress.gif no
Use custom caret General->Editors->Text Editors->Accessibility PREFERENCE_USE_CUSTOM_CARETS AbstractTextEditor Progress.gif no
Enable thick caret General->Editors->Text Editors->Accessibility PREFERENCE_WIDE_CARET AbstractTextEditor Ok green.gif yes
Enable on demand hyperlink… General->Editors->Text Editors->Hyperlinking PREFERENCE_HYPERLINKS_ENABLED AbstractTextEditor Glass.gif not testable on plain text editor
Default modifier key General->Editors->Text Editors->Hyperlinking PREFERENCE_HYPERLINK_KEY_MODIFIER AbstractTextEditor Glass.gif not testable on plain text editor
Glass.gif Glass.gif PREFERENCE_RULER_CONTRIBUTIONS AbstractTextEditor Glass.gif pref page not found
Show whitespace characters General->Editors->Text Editors PREFERENCE_SHOW_WHITESPACE_CHARACTERS AbstractTextEditor Progress.gif no
Enable drag and drop of text General->Editors->Text Editors PREFERENCE_TEXT_DRAG_AND_DROP_ENABLED AbstractTextEditor Progress.gif no
When mouse moved into hover… General->Editors->Text Editors PREFERENCE_HOVER_ENRICH_MODE AbstractTextEditor Progress.gif no
Glass.gif Glass.gif OVERVIEW_RULER AbstractDecoratedTextEditor Glass.gif pref page not found
Glass.gif Glass.gif DISABLE_OVERWRITE_MODE AbstractDecoratedTextEditor Glass.gif pref page not found
Show line numbers General->Editors->Text Editors LINE_NUMBER_RULER AbstractDecoratedTextEditor Ok green.gif yes
Enable quick diff General->Editors->Text Editors->Quick Diff QUICK_DIFF_ALWAYS_ON AbstractDecoratedTextEditor Ok green.gif yes
Show differences in overview ruler General->Editors->Text Editors->Quick Diff Glass.gif Glass.gif Ok green.gif yes
Colors General->Editors->Text Editors->Quick Diff Glass.gif Glass.gif Progress.gif EXCEPTION, but works
Displayed tab width General->Editors->Text Editors EDITOR_TAB_WIDTH AbstractDecoratedTextEditor no
Insert spaces for tabs General->Editors->Text Editors EDITOR_SPACES_FOR_TABS AbstractDecoratedTextEditor no
Undo history size General->Editors->Text Editors EDITOR_UNDO_HISTORY_SIZE AbstractDecoratedTextEditor Glass.gif not tested
Show range indicator General->Editors->Text Editors SHOW_RANGE_INDICATOR AbstractDecoratedTextEditor Glass.gif what is range indication
Enable spell checking General->Editors->Text Editors->Spelling PREFERENCE_SPELLING_ENABLED TextEditor Ok green.gif yes
Highlight current line General->Editors->Text Editors Glass.gif Glass.gif Progress.gif EXCEPTION when turning on, but works
Show print margin General->Editors->Text Editors Glass.gif Glass.gif Progress.gif EXCEPTION
Smart caret positioning at line start and end General->Editors->Text Editors Glass.gif Glass.gif Progress.gif no
Progress.gif General->Editors->Text Editors->Linked Mode Glass.gif Glass.gif Glass.gif not tested
Vertical ruler General->Editors->Text Editors->Annotations Glass.gif Glass.gif Ok green.gif yes
Overview ruler General->Editors->Text Editors->Annotations Glass.gif Glass.gif Ok green.gif yes
Text as General->Editors->Text Editors->Annotations Glass.gif Glass.gif Progress.gif EXCEPTION, but works
Color General->Editors->Text Editors->Annotations Glass.gif Glass.gif Progress.gif EXCEPTION, but works