Added code preview for “find usages” and related refactorings

[troizet]

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]

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]

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

[troizet]

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

[mbien]

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]

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

[mbien]

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]

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]

@troizet One of the best, thanks

[mclaborn]

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

[istinnstudio]

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.