Package com.intellij.ide.ui.search

Class SearchableOptionProcessor

java.lang.Object

com.intellij.ide.ui.search.SearchableOptionProcessor

public abstract class SearchableOptionProcessor
extends java.lang.Object

A place for SearchableOptionContributor implementations to feed the searchable options to.

Constructor Summary

Constructors

Constructor and Description
SearchableOptionProcessor()

Method Summary

Modifier and Type	Method and Description
abstract void	addOptions(java.lang.String text, java.lang.String path, java.lang.String hit, java.lang.String configurableId, java.lang.String configurableDisplayName, boolean applyStemming) Take text that can be found on a setting page, split it into words and add them to the internal setting search index.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchableOptionProcessor

public SearchableOptionProcessor()

Method Detail

addOptions

public abstract void addOptions(java.lang.String text,
                                java.lang.String path,
                                java.lang.String hit,
                                java.lang.String configurableId,
                                java.lang.String configurableDisplayName,
                                boolean applyStemming)

Take text that can be found on a setting page, split it into words and add them to the internal setting search index.

Parameters:

text - the text that appears on a setting page and can be searched for

path - for complex settings pages, identifies the subpage where the option is to be found. For example, it can be the name of tab on the settings page that should be opened when showing search results. Can be null for simple configurables.

hit - the string that's presented to the user when showing found results in a list, e.g. in Goto Action.

configurableId - the id of the topmost configurable containing the search result. See SearchableConfigurable.getId()

configurableDisplayName - display name of the configurable containing the search result

applyStemming - whether only word stems should be indexed or the full words. Porter stemmer is used.