OptionsPanelController.ContainerRegistration (Options Dialog and SPI)

Skip navigation links

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

All Classes

SEARCH:

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

```
@Target(PACKAGE)
@Retention(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	Description
`java.lang.String`	`categoryName`	Label shown on the button.
`java.lang.String`	`iconBase`	Path to icon for the button.
`java.lang.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	Description
`java.lang.String`	`keywords`	Optional keywords (separated by commas) for use with Quick Search (must also specify `keywordsCategory()`).
`java.lang.String`	`keywordsCategory`	Keyword category for use with Quick Search (must also specify `keywords()`).
`int`	`position`	Position relative to other top-level panels.

- Element Detail
  - id
```
java.lang.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
```
java.lang.String categoryName
```
    Label shown on the button. You may use #key syntax.
- - iconBase
```
java.lang.String iconBase
```
    Path to icon for the button.
- - keywords
```
java.lang.String keywords
```
    Optional keywords (separated by commas) for use with Quick Search (must also specify keywordsCategory()). You may use #key syntax.
    
    Default:
    
    ""
- - keywordsCategory
```
java.lang.String keywordsCategory
```
    Keyword category for use with Quick Search (must also specify keywords()).
    
    Default:
    
    ""
- - position
```
int position
```
    Position relative to other top-level panels.
    
    Default:
    
    2147483647

Skip navigation links

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

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

Built on April 24 2018. | Portions Copyright 1997-2018 Oracle. All rights reserved.