org.netbeans.spi.search

Class SearchScopeDefinition

java.lang.Object

org.netbeans.spi.search.SearchScopeDefinition

public abstract class SearchScopeDefinition
extends Object

Interface for obtaining information about scope of a search task. Instances are created by SearchScopeDefinitionProvider every time new Search dialog is opened.

Constructor Summary

Constructors

Constructor and Description
SearchScopeDefinition()

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener l) Registers a listener listening for changes of applicability.
abstract void	clean() This method is called when this search scope definition is no longer needed.
String	getAdditionalInfo() Returns an additional information about this search scope.
abstract String	getDisplayName() Returns human-readable, localized name of this search scope.
Icon	getIcon() Get icon to show in the combo box.
abstract int	getPriority() Get priority of this search scope.
abstract SearchInfo	getSearchInfo() Returns object defining the actual search scope, i.e.
abstract String	getTypeId() Identifies type of search scope.
abstract boolean	isApplicable() Is this search scope applicable at the moment? For example, search scope of all open projects is not applicable if there is no open project.
protected void	notifyListeners() This method should be called whenever the state of current search scope changes.
void	removeChangeListener(ChangeListener l) Unregisters a listener listening for changes of applicability.
void	selected() This method is called when the search scope is selected in the UI.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchScopeDefinition

public SearchScopeDefinition()

Method Detail

getTypeId

@NonNull
public abstract String getTypeId()

Identifies type of search scope.

getDisplayName

@NonNull
public abstract String getDisplayName()

Returns human-readable, localized name of this search scope.

Returns:

name of this search scope

getAdditionalInfo

@CheckForNull
public String getAdditionalInfo()

Returns an additional information about this search scope. This information may (but may not) be displayed by the scope's display name, possibly rendered using a different font (style, colour). The default implementation returns null.

Returns:

string with the additional information, or null if no additional information is available

isApplicable

public abstract boolean isApplicable()

Is this search scope applicable at the moment? For example, search scope of all open projects is not applicable if there is no open project.

Returns:

true if this search scope is applicable, false otherwise

addChangeListener

public final void addChangeListener(@NonNull
                                    ChangeListener l)

Registers a listener listening for changes of applicability. Registered listeners should be notified each time this SearchScope changes.

Parameters:

l - listener to be registered

See Also:

SearchScopeDefinition.isApplicable()

removeChangeListener

public final void removeChangeListener(@NonNull
                                       ChangeListener l)

Unregisters a listener listening for changes of applicability. If the passed listener is not currently registered or if the passed listener is null, this method has no effect.

Parameters:

l - listener to be unregistered

See Also:

SearchScopeDefinition.addChangeListener(javax.swing.event.ChangeListener), SearchScopeDefinition.isApplicable()

notifyListeners

protected final void notifyListeners()

This method should be called whenever the state of current search scope changes.

getSearchInfo

@NonNull
public abstract SearchInfo getSearchInfo()

Returns object defining the actual search scope, i.e. the iterator over FileObjects to be searched.

Returns:

SearchInfo defining the search scope

toString

public String toString()

Overrides:

toString in class Object

getPriority

public abstract int getPriority()

Get priority of this search scope. The lower priority - the higher position in the combo box.

clean

public abstract void clean()

This method is called when this search scope definition is no longer needed.

selected

public void selected()

This method is called when the search scope is selected in the UI. Default implementation does nothing.

getIcon

@CheckForNull
public Icon getIcon()

Get icon to show in the combo box. The default implementation returns null.

Returns:

The icon, or null.

Since:

api.search/1.10