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

org.netbeans.spi.options
Annotation Type OptionsPanelController.SubRegistration


@Target(value={TYPE,METHOD})
@Retention(value=SOURCE)
public static @interface OptionsPanelController.SubRegistration

Registers a subpanel inside a top-level container panel in the Options dialog. Should be placed on a OptionsPanelController instance.

Since:
org.netbeans.modules.options.api/1 1.14
See Also:
AdvancedOption

Required Element Summary
 String displayName
          Label shown on the tab.
 
Optional Element Summary
 String id
          Optional path that can be used (with location()) in OptionsDisplayer.open(String).
 String keywords
          Optional keywords (separated by commas) for use with Quick Search (must also specify keywordsCategory()).
 String keywordsCategory
          Keyword category for use with Quick Search (must also specify keywords()).
 String location
          Location of this panel inside some top-level panel matching OptionsPanelController.ContainerRegistration.id().
 int position
          Position relative to sibling subpanels.
 

Element Detail

displayName

public abstract String displayName
Label shown on the tab. You may use #key syntax.

id

public abstract String id
Optional path that can be used (with location()) in OptionsDisplayer.open(String). Typically this should be a reference to a compile-time constant to which other code can refer.

Default:
""

location

public abstract String location
Location of this panel inside some top-level panel matching OptionsPanelController.ContainerRegistration.id(). If unspecified, placed in the Miscellaneous panel. Typically this should be a reference to a compile-time constant also used for the container's ID.

Default:
"Advanced"

keywords

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

Default:
""

keywordsCategory

public abstract String keywordsCategory
Keyword category for use with Quick Search (must also specify keywords()).

Default:
""

position

public abstract int position
Position relative to sibling subpanels. Accepted only for non-default location() (Miscellaneous panel is sorted alphabetically).

Default:
2147483647

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

Built on July 6 2010.  |  Portions Copyright 1997-2010 Sun Microsystems, Inc. All rights reserved.