org.netbeans.api.search.ui

Class SearchPatternController

java.lang.Object

org.netbeans.api.search.ui.SearchPatternController

public final class SearchPatternController
extends Object

Controller for a combo box for selection and editing of search patterns.

Since:

api.search/1.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchPatternController.Option Options of search patterns.

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.
void	bind(SearchPatternController.Option option, AbstractButton button) Bind an abstract button (usually checkbox) to a SearchPattern option.
void	bindMatchTypeComboBox(JComboBox comboBox) Bind Match Type option to a combo box.
protected void	fireChange() Fires a change event to all registered listeners.
T	getComponent()
SearchPattern	getSearchPattern() Get search pattern currently represented by this controller.
boolean	hasListeners() Checks if there are any listeners registered to this ChangeSupport.
void	removeChangeListener(ChangeListener listener) Removes a ChangeListener from the listener list.
void	setSearchPattern(SearchPattern searchPattern) Set text and options to represent a search pattern.
void	unbind(SearchPatternController.Option option, AbstractButton button) Unbind a button from a SearchPattern option.

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

getSearchPattern

@NonNull
public SearchPattern getSearchPattern()

Get search pattern currently represented by this controller.

setSearchPattern

public void setSearchPattern(@NonNull
                             SearchPattern searchPattern)

Set text and options to represent a search pattern.

bind

public void bind(@NonNull
                 SearchPatternController.Option option,
                 @NonNull
                 AbstractButton button)

Bind an abstract button (usually checkbox) to a SearchPattern option.

Parameters:

option - Option whose value the button should represent.

button - Button to control and display the option.

bindMatchTypeComboBox

public void bindMatchTypeComboBox(@NonNull
                                  JComboBox comboBox)

Bind Match Type option to a combo box.

Parameters:

comboBox - Combo box to control and display the match type. The model of the combo box can contain only items of type SearchPattern.MatchType. SearchPattern.MatchType.LITERAL and SearchPattern.MatchType.REGEXP are mandatory in the model.

Since:

api.search/1.11

unbind

public void unbind(@NonNull
                   SearchPatternController.Option option,
                   @NonNull
                   AbstractButton button)

Unbind a button from a SearchPattern option.

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.