org.netbeans.api.search.ui

Class ScopeOptionsController

java.lang.Object

org.netbeans.api.search.ui.ScopeOptionsController

public final class ScopeOptionsController
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected JCheckBox	chkUseIgnoreList
protected T	component
protected JPanel	ignoreListOptionPanel

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()
JPanel	getFileNameComponent() Get the panel containing controls related to file name pattern settings.
SearchScopeOptions	getSearchScopeOptions() Return search scope options reflecting the actual state of the panel.
boolean	hasListeners() Checks if there are any listeners registered to this ChangeSupport.
boolean	isFileNameRegExp()
boolean	isSearchInArchives() State of checkbox for enabling searching in archives.
boolean	isSearchInGenerated() State of checkbox for enabling searching in generated sources.
boolean	isUseIgnoreList() State of checkbox for using ignore list.
void	removeChangeListener(ChangeListener listener) Removes a ChangeListener from the listener list.
void	setFileNameRegexp(boolean fileNameRegexp) Enable/disable regular expression mode.
void	setSearchInArchives(boolean searchInArchives) Enable/disable searching in archives.
void	setSearchInGenerated(boolean searchInGenerated) Enable/disable searching in generated sources.
void	setUseIgnoreList(boolean useIgnoreList) Enable/disable using ignore list.

Methods inherited from class java.lang.Object

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

Field Detail

ignoreListOptionPanel

protected JPanel ignoreListOptionPanel

chkUseIgnoreList

protected JCheckBox chkUseIgnoreList

component

protected T extends JComponent component

Method Detail

getSearchScopeOptions

public SearchScopeOptions getSearchScopeOptions()

Return search scope options reflecting the actual state of the panel. Modifying returned object will not affect this panel.

isSearchInArchives

public boolean isSearchInArchives()

State of checkbox for enabling searching in archives.

Returns:

True if searching in archives is enabled, false if it is disabled.

isSearchInGenerated

public boolean isSearchInGenerated()

State of checkbox for enabling searching in generated sources. Generated sources include class files or web service stubs generated for WSDL files. These files are usualy filtered out by SharabilityQuery.

Returns:

True if searching in generated sources is enabled, false otherwise.

See Also:

SharabilityQuery

isUseIgnoreList

public boolean isUseIgnoreList()

State of checkbox for using ignore list. If this method returns true, SearchScopeOptions object returned from ScopeOptionsController.getSearchScopeOptions() includes filter for ignored files.

Returns:

True if ignore list is enabled, false otherwise.

isFileNameRegExp

public boolean isFileNameRegExp()

Returns:

True if file name pattern is set to be used as regular expression for matching the whole file path, false is it should be used as simple pattern for file names.

setSearchInArchives

public void setSearchInArchives(boolean searchInArchives)

Enable/disable searching in archives.

setSearchInGenerated

public void setSearchInGenerated(boolean searchInGenerated)

Enable/disable searching in generated sources.

setUseIgnoreList

public void setUseIgnoreList(boolean useIgnoreList)

Enable/disable using ignore list.

setFileNameRegexp

public void setFileNameRegexp(boolean fileNameRegexp)

Enable/disable regular expression mode.

See Also:

ScopeOptionsController.isFileNameRegExp()

getFileNameComponent

@NullUnknown
public JPanel getFileNameComponent()

Get the panel containing controls related to file name pattern settings. This is only applicable if the controller was created using ComponentUtils.adjustPanelsForOptions(JPanel, JPanel, boolean, FileNameController).

Returns:

Panel containing controls related to file name pattern settings, or null if there is a single panel for all settings.

Since:

api.search/1.12

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.