org.netbeans.spi.search.provider

Class SearchResultsDisplayer<T>

java.lang.Object

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

Type Parameters:

T - Type of result of file content matching.

Direct Known Subclasses:

DefaultSearchResultsDisplayer

public abstract class SearchResultsDisplayer<T>
extends Object

Define how search results (and search controls) should be displayed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchResultsDisplayer.NodeDisplayer<T> Helper class for transforming matching objects to nodes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SearchResultsDisplayer() Constructor for subclasses.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addMatchingObject(T object) This method is called when a new matching object is found.
void	closed() Called right after the displayer is closed.
static <U> DefaultSearchResultsDisplayer<U>	createDefault(SearchResultsDisplayer.NodeDisplayer<U> helper, SearchComposition<U> searchComposition, SearchProvider.Presenter presenter, String title) Get default displayer that shows results as a tree of nodes.
abstract String	getTitle() Return title of this displayer.
abstract 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultsDisplayer

protected SearchResultsDisplayer()

Constructor for subclasses.

Method Detail

getVisualComponent

@NonNull
public abstract JComponent getVisualComponent()

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

addMatchingObject

public abstract void addMatchingObject(@NonNull
                     T 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.

searchStarted

public void searchStarted()

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

searchFinished

public void searchFinished()

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

createDefault

public static <U> DefaultSearchResultsDisplayer<U> createDefault(@NonNull
                                                 SearchResultsDisplayer.NodeDisplayer<U> helper,
                                                 @NonNull
                                                 SearchComposition<U> searchComposition,
                                                 @NullAllowed
                                                 SearchProvider.Presenter presenter,
                                                 @NonNull
                                                 String title)

Get default displayer that shows results as a tree of nodes.

Parameters:

helper - Helper that returns nodes for matching objects.

searchComposition - Search composition of the displayer is created for.

presenter - Presenter that can be shown to modify search criteria.

title - Title that will be shown in the tab of search results window.

getTitle

@NonNull
public abstract String getTitle()

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

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 getVisualComponent(). The default implementation does nothing. Override it if you want to add the info node to your UI.

closed

public void closed()

Called right after the displayer is closed. It should be overriden to release all held resources. The default implementation does nothing.