org.netbeans.spi.search.provider

Class DefaultSearchResultsDisplayer<U>

java.lang.Object

org.netbeans.spi.search.provider.SearchResultsDisplayer<U>

org.netbeans.spi.search.provider.DefaultSearchResultsDisplayer<U>

public final class DefaultSearchResultsDisplayer<U>
extends SearchResultsDisplayer<U>

Default search results displayer.

Since:

api.search/1.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultSearchResultsDisplayer.ResultNodeShiftSupport Class definining which nodes should be selected when Previous or Next button is pressed and what action should be performed.

Nested classes/interfaces inherited from class org.netbeans.spi.search.provider.SearchResultsDisplayer

SearchResultsDisplayer.NodeDisplayer<T>

Method Summary

Modifier and Type	Method and Description
void	addButton(AbstractButton button) Add a button to the results displayer toolbar.
void	addMatchingObject(U object) This method is called when a new matching object is found.
OutlineView	getOutlineView() Get outline view.
String	getTitle() Return title of this displayer.
JComponent	getVisualComponent() Get component that will be shown in the Search Results window.
void	searchFinished() Called right after the search was finished.
void	searchStarted() Called right after the search was started.
void	setInfoNode(Node infoNode) Set node that display information from the search listener.
void	setResultNodeShiftSupport(DefaultSearchResultsDisplayer.ResultNodeShiftSupport resultNodeShiftSupport) Set a custom DefaultSearchResultsDisplayer.ResultNodeShiftSupport for this displayer.

Methods inherited from class org.netbeans.spi.search.provider.SearchResultsDisplayer

closed, createDefault

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVisualComponent

public JComponent getVisualComponent()

Get component that will be shown in the Search Results window. Is should be created lazily.

Specified by:

getVisualComponent in class SearchResultsDisplayer<U>

addMatchingObject

public void addMatchingObject(U object)

This method is called when a new matching object is found. It should add representation of this matching object to model of created visual component.

Specified by:

addMatchingObject in class SearchResultsDisplayer<U>

getTitle

public String getTitle()

Return title of this displayer. It will be displayed in the tab within search results window.

Specified by:

getTitle in class SearchResultsDisplayer<U>

searchStarted

public void searchStarted()

Called right after the search was started. Default implementation does nothing.

Overrides:

searchStarted in class SearchResultsDisplayer<U>

searchFinished

public void searchFinished()

Called right after the search was finished. Default implementation does nothing.

Overrides:

searchFinished in class SearchResultsDisplayer<U>

getOutlineView

@NonNull
public OutlineView getOutlineView()

Get outline view. You can alter it to display additional node properties, or set custom cell renderer.

Returns:

OutlineView used in the results displayer.

setInfoNode

public void setInfoNode(Node infoNode)

Set node that display information from the search listener. This method is called right after a new displayer is created, before method SearchResultsDisplayer.getVisualComponent(). The default implementation does nothing. Override it if you want to add the info node to your UI.

Overrides:

setInfoNode in class SearchResultsDisplayer<U>

setResultNodeShiftSupport

public void setResultNodeShiftSupport(DefaultSearchResultsDisplayer.ResultNodeShiftSupport resultNodeShiftSupport)

Set a custom DefaultSearchResultsDisplayer.ResultNodeShiftSupport for this displayer.

addButton

public void addButton(@NonNull
                      AbstractButton button)

Add a button to the results displayer toolbar. It will be shown right above the stop button.

Parameters:

button - Button to add.