org.netbeans.spi.options

Annotation Type OptionsPanelController.Keywords

@Target(value=TYPE)
 @Retention(value=SOURCE)
public static @interface OptionsPanelController.Keywords

Registers keywords for some panel in the Options dialog. Should be placed on a JPanel instance.

Since:

org.netbeans.modules.options.api/1 1.29

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	keywords Keywords for use with search inside the Options dialog.
String	location Keyword category for use with search inside the Options dialog.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	tabTitle Optional title that must be used if the panel is part of a tabbed pane, such as when it is in the Editor, Fonts & Colors, Java, PHP, C/C++ or Miscellaneous categories, matching the OptionsPanelController.SubRegistration.displayName().

Element Detail

keywords

public abstract String[] keywords

Keywords for use with search inside the Options dialog. You may use #key syntax. The case in not important.

Each entry in the provided array is split around comma character. For example:

Split examples showing array and keywords

Provided array	Keywords
{ "Boo", "fOo" }	{ "BOO", "FOO" }
{ "boo and", "foo" }	{ "BOO AND", "FOO" }
{ "boo,and", "foo" }	{ "BOO", "AND", "FOO" }

The user's search-text is split around the space character to form words. All words need to be present in a panel to yield a successful search. The registered keywords {"Boo,anD", "fOo"}, for example, yield the following results with these search-texts:

Search examples showing search-text and results

User's search-text	Result
"boo"	keyword found
"nd"	keyword found
"boo and"	keyword found
"boo moo"	keyword NOT found

location

public abstract String location

Keyword category for use with search inside the Options dialog. Location of this panel inside some top-level panel matching OptionsPanelController.ContainerRegistration.id() or OptionsPanelController.SubRegistration.location(). Typically this should be a reference to a compile-time constant also used for the container's ID. If the panel is in the Miscellaneous category you must also specify OptionsPanelController.Keywords.tabTitle()).

tabTitle

public abstract String tabTitle

Optional title that must be used if the panel is part of a tabbed pane, such as when it is in the Editor, Fonts & Colors, Java, PHP, C/C++ or Miscellaneous categories, matching the OptionsPanelController.SubRegistration.displayName(). You may use #key syntax.

Default:

""