org.netbeans.spi.search.provider

Class SearchProvider.Presenter

java.lang.Object

org.netbeans.spi.search.provider.SearchProvider.Presenter

Enclosing class:

SearchProvider

public abstract static class SearchProvider.Presenter
extends Object

Presenter for search provider. This class is used to show panel and start the search task.

Example:

 
 class ExampleSearchPresenter
       extends BasicSearchProvider.Presenter {

   BasicSearchForm form = null;
   private boolean replacing;

   public ExampleSearchPresenter(boolean replacing) {
       this.replacing = replacing;
   }

   public JComponent getForm() {
       if (form == null) {
           form = new Form(); // create a new with UI for specifying search settings
           form.setName("Example Provider");
       }
       return form;
   }

   public SearchComposition<Def> composeSearch() {
       // here create a new search composition appropriate for settings 
       // specified in the form.
   }

   public boolean isUsable() {
       return form.isUsable();
   }

   public void addUsabilityChangeListener(ChangeListener cl) {
       form.setUsabilityChangeListener(cl);
   }

   public void clean() {
       super.clean();
       form.clean();
   }    
 }

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Presenter(SearchProvider searchProvider, boolean replacing) Constructor for subclasses.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener changeListener) Adds a ChangeListener to the listener list.
void	clean() Method called when the dialog is closed.
abstract SearchComposition<?>	composeSearch() Performs search considering current settings in the panel that was returned by SearchProvider.Presenter.getForm()
protected void	fireChange() Fires a change event to all registered listeners.
abstract JComponent	getForm() Return a JComponent that contains controls for setting search options.
HelpCtx	getHelpCtx() Get help ID for this type of search.
SearchProvider	getSearchProvider() Get associated search provider.
boolean	hasListeners() Checks if there are any listeners registered to thisChangeSupport.
boolean	isReplacing() Get replace mode.
abstract boolean	isUsable(NotificationLineSupport notificationLineSupport) Test that the current settings specified in associated form are usable for searching.
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

Constructor Detail

Presenter

protected Presenter(SearchProvider searchProvider,
                    boolean replacing)

Constructor for subclasses.

Parameters:

searchProvider - Provider this instance is created for.

replacing - True if the presenter should be shown in replace dialog, false if it should be shown in find dialog.

Method Detail

getForm

@NonNull
public abstract JComponent getForm()

Return a JComponent that contains controls for setting search options. It will be shown as a tab in search dialog. All invocations of this method on this object should return the same object. You should update inner state of this presenter from the component, or store reference to created component in this presenter, so that the current settings can be obtained from the form when a new search is started, i.e. when SearchProvider.Presenter.composeSearch() is called.

composeSearch

@NonNull
public abstract SearchComposition<?> composeSearch()

Performs search considering current settings in the panel that was returned by SearchProvider.Presenter.getForm()

Returns:

A new search composition.

isUsable

public abstract boolean isUsable(@NonNull
                                 NotificationLineSupport notificationLineSupport)

Test that the current settings specified in associated form are usable for searching.

Parameters:

notificationLineSupport - You can set warning, info or error message shown in the dialog using this object. If you set warning or error messages, call NotificationLineSupport.clearMessages() before this method returns true.

Returns:

True if search can start with the current settings, false otherwise.

addChangeListener

public final void addChangeListener(@NullAllowed
                                    ChangeListener changeListener)

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:

changeListener - the ChangeListener to be added.

removeChangeListener

public final void removeChangeListener(@NullAllowed
                                       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 thisChangeSupport.

Returns:

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

clean

public void clean()

Method called when the dialog is closed. It should release allocated resources. The default implementation does nothing.

getSearchProvider

public final SearchProvider getSearchProvider()

Get associated search provider.

Returns:

Provider this presenter was created for.

isReplacing

public final boolean isReplacing()

Get replace mode.

Returns:

True if the presenter should be shown in replace dialog, false if it should be shown if find dialog.

getHelpCtx

@CheckForNull
public HelpCtx getHelpCtx()

Get help ID for this type of search. Can return null if it is not available.