OptionsPanelController.TopLevelRegistration (Options Dialog and SPI)

Skip navigation links

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

Prev Class
Next Class

All Classes

SEARCH:

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

```
@Target({TYPE,METHOD})
@Retention(SOURCE)
public static @interface OptionsPanelController.TopLevelRegistration
```
Registers a simple panel at the top level of the Options dialog. Should be placed on a OptionsPanelController instance.

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.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`java.lang.String`	`id`	Optional path that can be used in `OptionsDisplayer.open(String)`.
`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
  - 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.
- - id
```
java.lang.String id
```
    Optional path that can be used in OptionsDisplayer.open(String). Typically this should be a reference to a compile-time constant to which other code can refer.
    
    Default:
    
    ""
- - 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

Prev Class
Next Class

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

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