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.
|
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() . |
public abstract String[] keywords
#key
syntax. The case in not important.
Each entry in the provided array is split around comma character. For example:
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:
User's search-text Result "boo" keyword found "nd" keyword found "boo and" keyword found "boo moo" keyword NOT found
public abstract String location
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()
).public abstract String tabTitle
OptionsPanelController.SubRegistration.displayName()
.
You may use #key
syntax.