Skip to content

Commit 67ca0f2

Browse files
NikkiAungNikkiAung
committed
feat: Add global search result navigation shortcuts
1 parent 34e3f47 commit 67ca0f2

File tree

9 files changed

+387
-4
lines changed

9 files changed

+387
-4
lines changed

‎bundles/org.eclipse.search/newsearch/org/eclipse/search2/internal/ui/SearchMessages.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ private SearchMessages() {
6969
public static String ShowNextResultAction_tooltip;
7070
public static String ShowPreviousResultAction_label;
7171
public static String ShowPreviousResultAction_tooltip;
72+
public static String GlobalNextSearchEntryAction_label;
73+
public static String GlobalNextSearchEntryAction_tooltip;
74+
public static String GlobalPreviousSearchEntryAction_label;
75+
public static String GlobalPreviousSearchEntryAction_tooltip;
7276
public static String RemoveMatchAction_label;
7377
public static String RemoveMatchAction_tooltip;
7478
public static String DefaultSearchViewPage_show_match;

‎bundles/org.eclipse.search/newsearch/org/eclipse/search2/internal/ui/SearchMessages.properties‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ ShowNextResultAction_label=Next Match
4242
ShowNextResultAction_tooltip=Show Next Match
4343
ShowPreviousResultAction_label=Previous Match
4444
ShowPreviousResultAction_tooltip=Show Previous Match
45+
GlobalNextSearchEntryAction_label=Next Search Entry
46+
GlobalNextSearchEntryAction_tooltip=Go to Next Search Result
47+
GlobalPreviousSearchEntryAction_label=Previous Search Entry
48+
GlobalPreviousSearchEntryAction_tooltip=Go to Previous Search Result
4549
RemoveMatchAction_label=Remove Match
4650
RemoveMatchAction_tooltip=Remove Currently Showing Match
4751
DefaultSearchViewPage_show_match=Show Match

‎bundles/org.eclipse.search/newsearch/org/eclipse/search2/internal/ui/basic/views/GlobalNextPrevSearchEntryHandler.java‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
/*******************************************************************************
2+
* Copyright (c) 2024 Eclipse Foundation and others.
3+
*
4+
* This program and the accompanying materials
5+
* are made available under the terms of the Eclipse Public License 2.0
6+
* which accompanies this distribution, and is available at
7+
* https://www.eclipse.org/legal/epl-2.0/
8+
*
9+
* SPDX-License-Identifier: EPL-2.0
10+
*
11+
* Contributors:
12+
* Eclipse Foundation - initial API and implementation
13+
*******************************************************************************/
14+
package org.eclipse.search2.internal.ui.basic.views;
15+
16+
import java.util.HashMap;
17+
18+
import org.eclipse.core.commands.AbstractHandler;
19+
import org.eclipse.core.commands.Command;
20+
import org.eclipse.core.commands.ExecutionEvent;
21+
import org.eclipse.core.commands.ExecutionException;
22+
import org.eclipse.core.commands.NotEnabledException;
23+
import org.eclipse.core.commands.NotHandledException;
24+
import org.eclipse.core.commands.ParameterizedCommand;
25+
import org.eclipse.core.commands.common.NotDefinedException;
26+
import org.eclipse.core.runtime.CoreException;
27+
import org.eclipse.core.runtime.IConfigurationElement;
28+
import org.eclipse.core.runtime.IExecutableExtension;
29+
import org.eclipse.swt.widgets.Event;
30+
import org.eclipse.ui.IWorkbenchCommandConstants;
31+
import org.eclipse.ui.IWorkbenchWindow;
32+
import org.eclipse.ui.commands.ICommandService;
33+
import org.eclipse.ui.handlers.HandlerUtil;
34+
import org.eclipse.ui.handlers.IHandlerService;
35+
36+
/**
37+
* Global handler for navigating to next/previous search results without requiring
38+
* focus on the Search view. This handler provides a seamless workflow for
39+
* navigating through search results while editing.
40+
*
41+
* @since 3.17
42+
*/
43+
public class GlobalNextPrevSearchEntryHandler extends AbstractHandler implements IExecutableExtension {
44+
private String searchCommand = IWorkbenchCommandConstants.NAVIGATE_NEXT;
45+
46+
@Override
47+
public Object execute(ExecutionEvent event) throws ExecutionException {
48+
IWorkbenchWindow window = HandlerUtil.getActiveWorkbenchWindowChecked(event);
49+
ICommandService cs = window.getService(ICommandService.class);
50+
51+
// Check if search view is available
52+
Command showView = cs.getCommand(IWorkbenchCommandConstants.VIEWS_SHOW_VIEW);
53+
if (!showView.isDefined()) {
54+
return null; // Search view not available, exit gracefully
55+
}
56+
57+
// Show the Search view
58+
HashMap<String, Object> parms = new HashMap<>();
59+
parms.put(IWorkbenchCommandConstants.VIEWS_SHOW_VIEW_PARM_ID, "org.eclipse.search.ui.views.SearchView"); //$NON-NLS-1$
60+
ParameterizedCommand showSearchView = ParameterizedCommand.generateCommand(showView, parms);
61+
62+
IHandlerService hs = window.getService(IHandlerService.class);
63+
Object triggerObj = event.getTrigger();
64+
Event trigger = (triggerObj instanceof Event) ? (Event) triggerObj : new Event();
65+
66+
try {
67+
// Execute the sequence: show search view -> navigate -> activate editor
68+
hs.executeCommand(showSearchView, trigger);
69+
hs.executeCommand(searchCommand, trigger);
70+
hs.executeCommand(IWorkbenchCommandConstants.WINDOW_ACTIVATE_EDITOR, trigger);
71+
} catch (NotDefinedException | NotEnabledException | NotHandledException e) {
72+
throw new ExecutionException(e.getMessage(), e);
73+
}
74+
75+
return null;
76+
}
77+
78+
@Override
79+
public void setInitializationData(IConfigurationElement config, String propertyName, Object data) throws CoreException {
80+
if ("previous".equals(data)) { //$NON-NLS-1$
81+
searchCommand = IWorkbenchCommandConstants.NAVIGATE_PREVIOUS;
82+
}
83+
}
84+
}

‎bundles/org.eclipse.search/plugin.xml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,20 @@
104104
name="%command.performTextSearchFile.name"
105105
description="%command.performTextSearchFile.description"
106106
/>
107+
<command
108+
categoryId="org.eclipse.ui.category.navigate"
109+
id="org.eclipse.search.ui.globalNextSearchEntry"
110+
name="%GlobalNextSearchEntryAction_label"
111+
description="%GlobalNextSearchEntryAction_tooltip"
112+
defaultHandler="org.eclipse.search2.internal.ui.basic.views.GlobalNextPrevSearchEntryHandler:next"
113+
/>
114+
<command
115+
categoryId="org.eclipse.ui.category.navigate"
116+
id="org.eclipse.search.ui.globalPreviousSearchEntry"
117+
name="%GlobalPreviousSearchEntryAction_label"
118+
description="%GlobalPreviousSearchEntryAction_tooltip"
119+
defaultHandler="org.eclipse.search2.internal.ui.basic.views.GlobalNextPrevSearchEntryHandler:previous"
120+
/>
107121

108122
</extension>
109123

@@ -162,6 +176,18 @@
162176
commandId="org.eclipse.search.ui.performTextSearchWorkspace"
163177
schemeId="org.eclipse.ui.defaultAcceleratorConfiguration"
164178
sequence="M1+M3+T"/>
179+
<key
180+
commandId="org.eclipse.search.ui.globalNextSearchEntry"
181+
contextId="org.eclipse.ui.contexts.window"
182+
schemeId="org.eclipse.ui.defaultAcceleratorConfiguration"
183+
sequence="ALT+.">
184+
</key>
185+
<key
186+
commandId="org.eclipse.search.ui.globalPreviousSearchEntry"
187+
contextId="org.eclipse.ui.contexts.window"
188+
schemeId="org.eclipse.ui.defaultAcceleratorConfiguration"
189+
sequence="ALT+,">
190+
</key>
165191

166192
</extension>
167193

‎tests/org.eclipse.search.tests/META-INF/MANIFEST.MF‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@ Require-Bundle:
1414
org.eclipse.search;bundle-version="[3.16.0,4.0.0)",
1515
org.eclipse.core.runtime;bundle-version="[3.29.100,4.0.0)",
1616
org.eclipse.core.resources;bundle-version="[3.19.200,4.0.0)",
17-
org.junit;bundle-version="4.13.0",
1817
org.eclipse.ui.workbench.texteditor;bundle-version="[3.17.200,4.0.0)",
1918
org.eclipse.jface.text;bundle-version="[3.24.200,4.0.0)",
2019
org.eclipse.ui.editors;bundle-version="[3.17.100,4.0.0)",
21-
org.eclipse.ltk.core.refactoring;bundle-version="[3.14.100,4.0.0)"
20+
org.eclipse.ltk.core.refactoring;bundle-version="[3.14.100,4.0.0)",
21+
org.junit;bundle-version="4.13.2",
22+
org.mockito.mockito-core;bundle-version="2.13.0"
2223
Import-Package: org.junit.jupiter.api;version="[5.14.0,6.0.0)",
24+
org.junit.jupiter.api.function;version="[5.14.0,6.0.0)",
2325
org.junit.platform.suite.api;version="[1.14.0,2.0.0)"
2426
Bundle-ActivationPolicy: lazy
2527
Bundle-RequiredExecutionEnvironment: JavaSE-17

‎tests/org.eclipse.search.tests/src/org/eclipse/search/tests/AllSearchTests.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
*******************************************************************************/
1414
package org.eclipse.search.tests;
1515

16-
import org.junit.platform.suite.api.Suite;
1716
import org.junit.platform.suite.api.SelectClasses;
17+
import org.junit.platform.suite.api.Suite;
1818

1919
import org.eclipse.search.core.tests.AllSearchModelTests;
2020
import org.eclipse.search.tests.filesearch.AllFileSearchTests;
@@ -23,7 +23,9 @@
2323
@SelectClasses({
2424
AllFileSearchTests.class,
2525
AllSearchModelTests.class,
26-
TextSearchRegistryTest.class
26+
TextSearchRegistryTest.class,
27+
GlobalNextPrevSearchEntryHandlerTest.class,
28+
GlobalNextPrevSearchEntryHandlerIntegrationTest.class
2729
})
2830
public class AllSearchTests {
2931
// see @SelectClasses

‎tests/org.eclipse.search.tests/src/org/eclipse/search/tests/GlobalNextPrevSearchEntryHandlerIntegrationTest.java‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
/*******************************************************************************
2+
* Copyright (c) 2024 Eclipse Foundation and others.
3+
*
4+
* This program and the accompanying materials
5+
* are made available under the terms of the Eclipse Public License 2.0
6+
* which accompanies this distribution, and is available at
7+
* https://www.eclipse.org/legal/epl-2.0/
8+
*
9+
* SPDX-License-Identifier: EPL-2.0
10+
*
11+
* Contributors:
12+
* Eclipse Foundation - initial API and implementation
13+
*******************************************************************************/
14+
package org.eclipse.search.tests;
15+
16+
import static org.junit.jupiter.api.Assertions.assertNotNull;
17+
18+
import org.eclipse.core.runtime.CoreException;
19+
import org.eclipse.search2.internal.ui.basic.views.GlobalNextPrevSearchEntryHandler;
20+
import org.junit.jupiter.api.Test;
21+
22+
/**
23+
* Integration tests for {@link GlobalNextPrevSearchEntryHandler}.
24+
* These tests verify the basic functionality and integration points.
25+
*
26+
* @since 3.17
27+
*/
28+
public class GlobalNextPrevSearchEntryHandlerIntegrationTest {
29+
30+
/**
31+
* Test that the handler can be created and configured properly.
32+
* This test verifies the basic instantiation and configuration functionality.
33+
*/
34+
@Test
35+
public void testHandlerCreationAndConfiguration() throws CoreException {
36+
// Test Next handler
37+
GlobalNextPrevSearchEntryHandler nextHandler = new GlobalNextPrevSearchEntryHandler();
38+
assertNotNull(nextHandler, "Next handler should be created successfully");
39+
40+
// Configure for next command (default behavior)
41+
nextHandler.setInitializationData(null, "command", "next");
42+
// No exception should be thrown
43+
44+
// Test Previous handler
45+
GlobalNextPrevSearchEntryHandler prevHandler = new GlobalNextPrevSearchEntryHandler();
46+
assertNotNull(prevHandler, "Previous handler should be created successfully");
47+
48+
// Configure for previous command
49+
prevHandler.setInitializationData(null, "command", "previous");
50+
// No exception should be thrown
51+
}
52+
53+
/**
54+
* Test that the handler handles various configuration scenarios correctly.
55+
*/
56+
@Test
57+
public void testHandlerConfigurationScenarios() throws CoreException {
58+
GlobalNextPrevSearchEntryHandler handler = new GlobalNextPrevSearchEntryHandler();
59+
60+
// Test with null configuration
61+
handler.setInitializationData(null, null, null);
62+
// Should not throw exception
63+
64+
// Test with empty string
65+
handler.setInitializationData(null, "", "");
66+
// Should not throw exception
67+
68+
// Test with unknown command type
69+
handler.setInitializationData(null, "command", "unknown");
70+
// Should not throw exception and should default to next behavior
71+
}
72+
73+
/**
74+
* Test that the handler can be instantiated and configured properly.
75+
*/
76+
@Test
77+
public void testHandlerInstantiationAndConfiguration() {
78+
GlobalNextPrevSearchEntryHandler handler = new GlobalNextPrevSearchEntryHandler();
79+
80+
// Verify handler can be created
81+
assertNotNull(handler, "Handler should be created successfully");
82+
83+
// Verify handler is properly instantiated (the class already implements required interfaces)
84+
// This test ensures the handler can be created without issues
85+
}
86+
87+
/**
88+
* Test that multiple handler instances can be created independently.
89+
*/
90+
@Test
91+
public void testMultipleHandlerInstances() throws CoreException {
92+
// Create multiple handlers
93+
GlobalNextPrevSearchEntryHandler handler1 = new GlobalNextPrevSearchEntryHandler();
94+
GlobalNextPrevSearchEntryHandler handler2 = new GlobalNextPrevSearchEntryHandler();
95+
GlobalNextPrevSearchEntryHandler handler3 = new GlobalNextPrevSearchEntryHandler();
96+
97+
// Configure them differently
98+
handler1.setInitializationData(null, "command", "next");
99+
handler2.setInitializationData(null, "command", "previous");
100+
handler3.setInitializationData(null, "command", "unknown");
101+
102+
// All should be created and configured without issues
103+
assertNotNull(handler1);
104+
assertNotNull(handler2);
105+
assertNotNull(handler3);
106+
}
107+
}

‎tests/org.eclipse.search.tests/src/org/eclipse/search/tests/GlobalNextPrevSearchEntryHandlerTest.java‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
/*******************************************************************************
2+
* Copyright (c) 2024 Eclipse Foundation and others.
3+
*
4+
* This program and the accompanying materials
5+
* are made available under the terms of the Eclipse Public License 2.0
6+
* which accompanies this distribution, and is available at
7+
* https://www.eclipse.org/legal/epl-2.0/
8+
*
9+
* SPDX-License-Identifier: EPL-2.0
10+
*
11+
* Contributors:
12+
* Eclipse Foundation - initial API and implementation
13+
*******************************************************************************/
14+
package org.eclipse.search.tests;
15+
16+
import static org.junit.jupiter.api.Assertions.assertNotNull;
17+
18+
import org.eclipse.core.runtime.CoreException;
19+
import org.eclipse.search2.internal.ui.basic.views.GlobalNextPrevSearchEntryHandler;
20+
import org.junit.jupiter.api.BeforeEach;
21+
import org.junit.jupiter.api.Test;
22+
23+
/**
24+
* Tests for {@link GlobalNextPrevSearchEntryHandler}.
25+
*
26+
* @since 3.17
27+
*/
28+
public class GlobalNextPrevSearchEntryHandlerTest {
29+
30+
private GlobalNextPrevSearchEntryHandler handler;
31+
32+
@BeforeEach
33+
public void setUp() {
34+
handler = new GlobalNextPrevSearchEntryHandler();
35+
}
36+
37+
/**
38+
* Test that the handler can be instantiated without errors.
39+
*/
40+
@Test
41+
public void testHandlerInstantiation() {
42+
// Verify handler was created successfully in setUp()
43+
assertNotNull(handler, "Handler should be created successfully");
44+
45+
// Verify handler is properly instantiated
46+
// If we get here, instantiation was successful
47+
}
48+
49+
/**
50+
* Test that setInitializationData works correctly for "previous" command.
51+
*/
52+
@Test
53+
public void testSetInitializationDataWithPreviousCommand() throws CoreException {
54+
// Test with "previous" data - should set the handler to use NAVIGATE_PREVIOUS
55+
handler.setInitializationData(null, "property", "previous");
56+
// If no exception is thrown, the method worked correctly
57+
}
58+
59+
/**
60+
* Test that setInitializationData works correctly for "next" command.
61+
*/
62+
@Test
63+
public void testSetInitializationDataWithNextCommand() throws CoreException {
64+
// Test with "next" data - should keep default NAVIGATE_NEXT behavior
65+
handler.setInitializationData(null, "property", "next");
66+
// If no exception is thrown, the method worked correctly
67+
}
68+
69+
/**
70+
* Test that setInitializationData works correctly with unknown command.
71+
*/
72+
@Test
73+
public void testSetInitializationDataWithUnknownCommand() throws CoreException {
74+
// Test with unknown data - should keep default NAVIGATE_NEXT behavior
75+
handler.setInitializationData(null, "property", "unknown");
76+
// If no exception is thrown, the method worked correctly
77+
}
78+
79+
/**
80+
* Test that setInitializationData works correctly with null data.
81+
*/
82+
@Test
83+
public void testSetInitializationDataWithNullData() throws CoreException {
84+
// Test with null data - should keep default NAVIGATE_NEXT behavior
85+
handler.setInitializationData(null, "property", null);
86+
// If no exception is thrown, the method worked correctly
87+
}
88+
89+
/**
90+
* Test that the handler can be instantiated and is properly configured.
91+
*/
92+
@Test
93+
public void testHandlerInstantiationAndConfiguration() {
94+
// Verify handler can be created and is not null
95+
assertNotNull(handler);
96+
97+
// Verify handler has expected default behavior
98+
// (This test verifies the handler is properly instantiated)
99+
}
100+
}

0 commit comments

Comments
 (0)