org.netbeans.api.search.ui

Class ScopeController

java.lang.Object

org.netbeans.api.search.ui.ScopeController

public final class ScopeController
extends Object

Component controller for selecting search scope. Use ComponentUtils to create instances of this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	component

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener listener) Adds a ChangeListener to the listener list.
protected void	fireChange() Fires a change event to all registered listeners.
T	getComponent()
SearchInfo	getSearchInfo() Get search info for selected search scope.
String	getSelectedScopeId()
String	getSelectedScopeTitle()
boolean	hasListeners() Checks if there are any listeners registered to this ChangeSupport.
void	removeChangeListener(ChangeListener listener) Removes a ChangeListener from the listener list.

Methods inherited from class java.lang.Object

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

Field Detail

component

protected T extends JComponent component

Method Detail

getSelectedScopeId

@CheckForNull
public String getSelectedScopeId()

Returns:

ID of selected search scope, or null if no scope is selected.

getSelectedScopeTitle

@CheckForNull
public String getSelectedScopeTitle()

getSearchInfo

@CheckForNull
public SearchInfo getSearchInfo()

Get search info for selected search scope.

Returns:

Appropriate search info, or null if not available.

getComponent

public final T getComponent()

addChangeListener

public final void addChangeListener(@NonNull
                                    ChangeListener listener)

Adds a ChangeListener to the listener list. The same listener object may be added more than once, and will be called as many times as it is added. If listener is null, no exception is thrown and no action is taken.

Parameters:

listener - the ChangeListener to be added.

removeChangeListener

public final void removeChangeListener(@NonNull
                                       ChangeListener listener)

Removes a ChangeListener from the listener list. If listener was added more than once, it will be notified one less time after being removed. If listener is null, or was never added, no exception is thrown and no action is taken.

Parameters:

listener - the ChangeListener to be removed.

fireChange

protected final void fireChange()

Fires a change event to all registered listeners.

hasListeners

public final boolean hasListeners()

Checks if there are any listeners registered to this ChangeSupport.

Returns:

true if there are one or more listeners for the given property, false otherwise.