Added code preview for “find usages” and related refactorings by troizet · Pull Request #7694 · apache/netbeans

troizet · 2024-08-25T07:15:45Z

I have to use find usages a lot and I really miss the ability to quickly view the contents of files.
I have to open tabs in the main editor, which sometimes leads to a lot of unnecessary tabs.

Example of code preview for find usages:

example_finud_usages_preview_2.mp4

An example of code preview for refactoring safely delete, which uses find usages functionality:

example_refactoring_using_find_usages_preview_2.mp4

I borrowed the preview implementation from here:

netbeans/ide/editor.bookmarks/src/org/netbeans/modules/editor/bookmarks/ui/BookmarksView.java

Lines 536 to 563 in 6c6beed

    
           void showPreview(FileObject fo, Document doc, BookmarkInfo bookmarkInfo) { 
        
               if (bookmarkInfo != displayedBookmarkInfo) { 
        
                   int lineIndex = bookmarkInfo.getCurrentLineIndex(); 
        
                   String mimeType = (String) doc.getProperty("mimeType"); //NOI18N 
        
                   if (mimeType != null) { 
        
                       JEditorPane pane = new JEditorPane(); 
        
                       EditorKit editorKit = MimeLookup.getLookup(mimeType).lookup(EditorKit.class); 
        
                       pane.setEditorKit(editorKit); 
        
                       pane.setDocument(doc); 
        
                       pane.setEditable(false); 
        
                       Component editorComponent; 
        
                       EditorUI editorUI = Utilities.getEditorUI(pane); 
        
                       if (editorUI != null) { 
        
                           editorComponent = editorUI.getExtComponent(); 
        
                       } else { 
        
                           editorComponent = new JScrollPane(pane); 
        
                       } 
        
                       previewPanel.removeAll(); 
        
                       previewPanel.add(editorComponent); 
        
                       int offset = BookmarkUtils.lineIndex2Offset(doc, lineIndex); 
        
                       pane.setCaretPosition(offset); 
        
                       displayedBookmarkInfo = bookmarkInfo; 
        
                       previewPanel.revalidate(); 
        
                   } 
        
               } 
        
           }

mbien

good idea! It causes some problems though atm. E.g java rename refactoring preview won't show as diff view now if the show-preview button was activated in the find usages window before.

I am also wondering if this is something which should be always enabled (no button), since i looked a bit around and no other window has a button to disable the diff view or preview right now. (checked bookmarks, refactoring and search windows)

(was curious if one of the language tests would be catching this, but everything is green)

troizet · 2024-08-25T15:22:57Z

It causes some problems though atm. E.g java rename refactoring preview won't show as diff view now if the show-preview button was activated in the find usages window before.

Thank you! I was only testing the case with one open panel and missed the point that multiple panels can be open at the same time. I'll look into it.

I am also wondering if this is something which should be always enabled (no button), since i looked a bit around and no other window has a button to disable the diff view or preview right now. (checked bookmarks, refactoring and search windows)

I think that using the preview for find usages is not mandatory as for refactoring, and should be at the user's discretion.
I also plan to add the same preview for searches.

Chris2011 · 2024-08-26T22:13:25Z

Great work, thx :) @troizet. I didn't look at the code, I just want to thank you.

troizet · 2024-08-28T16:12:41Z

Regarding the button, I still tend to believe that it is necessary. Maybe put this question on the mailing list for discussion?

mbien · 2024-08-28T18:01:59Z

Regarding the button, I still tend to believe that it is necessary. Maybe put this question on the mailing list for discussion?

sure why not. My main point is consistency. A button like this should be on all comparable query-type windows which have a preview. You already mentioned you want to add it to search too, bookmarks window would need it too etc. The easier solution would be no button, since nothing has one atm (this would be also consistent).

The code inspection window (not the refactoring window) has currently no preview, the panel on the right is used for the hint description.

troizet · 2024-09-20T17:59:10Z

@mbien Removed the preview button. I will try to add it in another PR in all places where it is needed.

mbien · 2024-09-26T11:59:42Z

sorry for the delay - I kept getting distracted by other things. Will try to take a look at this this evening - lets try go get this cool feature in.

edit: looks good, I believe most similar windows do have a preview now:

troizet · 2024-09-26T14:29:10Z

I also made a PR for the search results #7779

mbien

thanks! works great.

matthiasblaesing

Looks sane to me. The search result window might be a good candidate to be enhanced similarly, but that is not necessarily in scope.

istinnstudio · 2024-12-13T13:32:46Z

@troizet One of the best, thanks

mclaborn · 2024-12-16T17:42:39Z

Don't like this. Can it be disabled by the user?

istinnstudio · 2024-12-16T18:07:37Z

As far as I can see, I think you only have to move the slider away to hide the preview. But it will not keep this position for the next "find". But all tabs will keep the user slider position until close.

troizet added the UI User Interface label Aug 25, 2024

mbien added Editor ci:all-tests [ci] enable all tests ci:dev-build [ci] produce a dev-build zip artifact (7 days expiration, see link on workflow summary page) labels Aug 25, 2024

mbien added this to the NB24 milestone Aug 25, 2024

apache locked and limited conversation to collaborators Aug 25, 2024

apache unlocked this conversation Aug 25, 2024

mbien removed the ci:all-tests [ci] enable all tests label Aug 25, 2024

mbien requested changes Aug 25, 2024

View reviewed changes

troizet force-pushed the find_usages_preview branch from e709b4a to 6f8b485 Compare August 25, 2024 16:47

mbien reviewed Aug 27, 2024

View reviewed changes

troizet force-pushed the find_usages_preview branch from 6f8b485 to dc00ca3 Compare August 28, 2024 16:10

troizet force-pushed the find_usages_preview branch from dc00ca3 to c11b5cd Compare September 20, 2024 17:54

mbien reviewed Sep 29, 2024

View reviewed changes

troizet force-pushed the find_usages_preview branch from c11b5cd to ec0ab03 Compare September 29, 2024 15:09

Added code preview for “find usages” and related refactorings

18c2f55

troizet force-pushed the find_usages_preview branch from ec0ab03 to 18c2f55 Compare September 30, 2024 15:33

mbien approved these changes Sep 30, 2024

View reviewed changes

mbien requested a review from matthiasblaesing September 30, 2024 16:41

matthiasblaesing approved these changes Sep 30, 2024

View reviewed changes

mbien merged commit 22de49f into apache:master Oct 1, 2024

mbien mentioned this pull request Dec 18, 2024

Minor improvements to new Usages preview panel (NB24) #8068

Closed

mbien mentioned this pull request Jan 5, 2025

Usages: Add means to disable code preview #8112

Closed

matthiasblaesing mentioned this pull request Mar 12, 2025

Enable switching preview for search results, refactoring and bookmarks #8326

Merged

nmatt mentioned this pull request Apr 28, 2025

"Find Usages" usability regression #8466

Open

	void showPreview(FileObject fo, Document doc, BookmarkInfo bookmarkInfo) {
	if (bookmarkInfo != displayedBookmarkInfo) {
	int lineIndex = bookmarkInfo.getCurrentLineIndex();
	String mimeType = (String) doc.getProperty("mimeType"); //NOI18N
	if (mimeType != null) {
	JEditorPane pane = new JEditorPane();
	EditorKit editorKit = MimeLookup.getLookup(mimeType).lookup(EditorKit.class);
	pane.setEditorKit(editorKit);
	pane.setDocument(doc);
	pane.setEditable(false);
	Component editorComponent;
	EditorUI editorUI = Utilities.getEditorUI(pane);
	if (editorUI != null) {
	editorComponent = editorUI.getExtComponent();
	} else {
	editorComponent = new JScrollPane(pane);
	}
	previewPanel.removeAll();
	previewPanel.add(editorComponent);

	int offset = BookmarkUtils.lineIndex2Offset(doc, lineIndex);
	pane.setCaretPosition(offset);
	displayedBookmarkInfo = bookmarkInfo;

	previewPanel.revalidate();
	}
	}
	}

Conversation

troizet commented Aug 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mbien left a comment

Choose a reason for hiding this comment

Uh oh!

troizet commented Aug 25, 2024

Uh oh!

Chris2011 commented Aug 26, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

troizet commented Aug 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mbien commented Aug 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

troizet commented Sep 20, 2024

Uh oh!

mbien commented Sep 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

troizet commented Sep 26, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mbien left a comment

Choose a reason for hiding this comment

Uh oh!

matthiasblaesing left a comment

Choose a reason for hiding this comment

Uh oh!

istinnstudio commented Dec 13, 2024

Uh oh!

mclaborn commented Dec 16, 2024

Uh oh!

istinnstudio commented Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

troizet commented Aug 25, 2024 •

edited

Loading

troizet commented Aug 28, 2024 •

edited

Loading

mbien commented Aug 28, 2024 •

edited

Loading

mbien commented Sep 26, 2024 •

edited

Loading

istinnstudio commented Dec 16, 2024 •

edited

Loading