org.netbeans.api.search.ui

Class ComponentUtils

java.lang.Object

org.netbeans.api.search.ui.ComponentUtils

public class ComponentUtils
extends Object

Class containing methods for creating controller objects for GUI components and adjusting their properties so that they can be used in search forms of search dialog.

Method Summary

Modifier and Type	Method and Description
static FileNameController	adjustComboForFileName(JComboBox jComboBox) Adjust a JComboBox to act as component for selecting file name pattern, and return a controller object for interacting with it.
static ScopeController	adjustComboForScope(JComboBox jComboBox, String preferredScopeId, SearchScopeDefinition... extraSearchScopes) Adjust a JComboBox to act as component for selecting search scope, and return a controller object for interacting with it.
static SearchPatternController	adjustComboForSearchPattern(JComboBox jComboBox) Adjust a JComboBox to act as component for selecting search text pattern, and return a controller object for interacting with it.
static ScopeOptionsController	adjustPanelForOptions(JPanel jPanel, boolean searchAndReplace, FileNameController fileNameController) Adjust an empty panel for specifying search scope options.
static ScopeOptionsController	adjustPanelsForOptions(JPanel scopePanel, JPanel fileNamePanel, boolean searchAndReplace, FileNameController fileNameController) Adjust two empty panels for specifying search scope options.

Methods inherited from class java.lang.Object

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

Method Detail

adjustComboForFileName

@NonNull
public static FileNameController adjustComboForFileName(@NonNull
                                                                 JComboBox jComboBox)

Adjust a JComboBox to act as component for selecting file name pattern, and return a controller object for interacting with it. Such ajdusted combo box is useful if you need a valid file name pattern for SearchScopeOptions that you want to pass to file object iterator of a SearchInfo. You can bind this combo box with scope options panel to toggle its regular-expresion mode.

Parameters:

jComboBox - Freshly created component that will be adjusted.

Returns:

Controller for modified jComboBox.

See Also:

ComponentUtils.adjustPanelForOptions(JPanel, boolean, FileNameController)

adjustComboForScope

@NonNull
public static ScopeController adjustComboForScope(@NonNull
                                                           JComboBox jComboBox,
                                                           @NullAllowed
                                                           String preferredScopeId,
                                                           @NonNull
                                                           SearchScopeDefinition... extraSearchScopes)

Adjust a JComboBox to act as component for selecting search scope, and return a controller object for interacting with it.

Parameters:

jComboBox - Freshly created component that will be modified.

preferredScopeId - Preferred search scope ID (e.g. "open projects", "main projects", "node selection").

extraSearchScopes - Extra search scopes that should be visible among standard search scopes created by SearchScopeDefinitionProviders.

Returns:

Controller for modified jComboBox.

See Also:

ScopeController.getSearchInfo()

adjustPanelForOptions

@NonNull
public static ScopeOptionsController adjustPanelForOptions(@NonNull
                                                                    JPanel jPanel,
                                                                    boolean searchAndReplace,
                                                                    @NonNull
                                                                    FileNameController fileNameController)

Adjust an empty panel for specifying search scope options. Several checkboxes and other controls will be addded to it, and its layout can be altered. Such ajdusted panel is useful if you want to let users customize options for SearchScopeOptions that you want to pass to file object iterator of a SearchInfo.

Parameters:

jPanel - Empty (with no child components) panel to adjust.

searchAndReplace - True if options for search-and-replace mode should be shown, false to show options for search-only mode.

fileNameController - File-name combo box that will be bound to this settings panel.

Returns:

Controller for adjusted jPanel with controls for setting search options (search in archives, search in generated sources, use ignore list, treat file name pattern as regular expression matching file path).

See Also:

ScopeOptionsController.getSearchScopeOptions()

adjustPanelsForOptions

@NonNull
public static ScopeOptionsController adjustPanelsForOptions(@NonNull
                                                                     JPanel scopePanel,
                                                                     @NonNull
                                                                     JPanel fileNamePanel,
                                                                     boolean searchAndReplace,
                                                                     @NonNull
                                                                     FileNameController fileNameController)

Adjust two empty panels for specifying search scope options. Several checkboxes and other controls will be addded to them, and their layout can be altered. Such ajdusted panels are useful if you want to let users customize options for SearchScopeOptions that you want to pass to file object iterator of a SearchInfo.

Parameters:

scopePanel - Empty (with no child components) panel to adjust for controls related to search scope (search in archives, search in generated sources).

fileNamePanel - Empty (with no child components) panel to adjust for controls related to file name pattern (regular expression, ignore list).

searchAndReplace - True if options for search-and-replace mode should be shown, false to show options for search-only mode.

fileNameController - File-name combo box that will be bound to this settings panel.

Returns:

Controller for adjusted JPanels with controls for setting search options (search in archives, search in generated sources, use ignore list, treat file name pattern as regular expression matching file path).

Since:

api.search/1.12

See Also:

ScopeOptionsController.getSearchScopeOptions()

adjustComboForSearchPattern

@NonNull
public static SearchPatternController adjustComboForSearchPattern(@NonNull
                                                                           JComboBox jComboBox)

Adjust a JComboBox to act as component for selecting search text pattern, and return a controller object for interacting with it. You can bind this combo box with some abstract buttons (usually check boxes) to set pattern options.

Parameters:

jComboBox - Freshly created component that will be adjusted.

Returns:

Controller for modified jComboBox.

Since:

api.search/1.1