org.netbeans.spi.options

Annotation Type OptionsPanelController.ContainerRegistration

@Target(value=PACKAGE)
 @Retention(value=SOURCE)
public static @interface OptionsPanelController.ContainerRegistration

Registers a panel with child panels at the top level of the Options dialog. May be placed on any package (i.e. package-info.java). Register children using OptionsPanelController.SubRegistration.

Since:

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

See Also:

OptionsCategory

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	categoryName Label shown on the button.
String	iconBase Path to icon for the button.
String	id Path that can be used in OptionsDisplayer.open(String) and OptionsPanelController.SubRegistration.location().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	keywords Optional keywords (separated by commas) for use with Quick Search (must also specify OptionsPanelController.ContainerRegistration.keywordsCategory()).
String	keywordsCategory Keyword category for use with Quick Search (must also specify OptionsPanelController.ContainerRegistration.keywords()).
int	position Position relative to other top-level panels.

Element Detail

id

public abstract String id

Path that can be used in OptionsDisplayer.open(String) and OptionsPanelController.SubRegistration.location(). Typically this should be a reference to a compile-time constant to which other code can refer.

categoryName

public abstract String categoryName

Label shown on the button. You may use #key syntax.

iconBase

public abstract String iconBase

Path to icon for the button.

keywords

public abstract String keywords

Optional keywords (separated by commas) for use with Quick Search (must also specify OptionsPanelController.ContainerRegistration.keywordsCategory()). You may use #key syntax.

Default:

""

keywordsCategory

public abstract String keywordsCategory

Keyword category for use with Quick Search (must also specify OptionsPanelController.ContainerRegistration.keywords()).

Default:

""

position

public abstract int position

Position relative to other top-level panels.

Default:

2147483647