org.netbeans.spi.project.ui.support

Annotation Type ProjectCustomizer.CompositeCategoryProvider.Registration

@Target(value={TYPE,METHOD,PACKAGE})
 @Retention(value=SOURCE)
public static @interface ProjectCustomizer.CompositeCategoryProvider.Registration

Used to register customizer panels. There are three ways this annotation can be used:

1. Register a "leaf" panel with no children. category() can be omitted for a top-level panel; if specified, the panel is placed in the named subcategory. categoryLabel() should not be specified. The annotation must be placed on a class or factory method implementing ProjectCustomizer.CompositeCategoryProvider.
2. Register a category folder with no panel. category() must be specified; the last path component is the folder being defined, and any previous components are parent folders. categoryLabel() must be specified. The annotation must be placed on some package declaration (in package-info.java).
3. Register a category folder also with its own panel (i.e. Self). category() and categoryLabel() must be specified as for #2, but the annotation must be on a provider implementation as for #1.

To represent hierarchies of panels, the category() of a #1 can match the category() of a #2 or #3, and the category() of a #2 or #3 preceding the last / can match the category() of another #2 or #3.

Multiple registrations may be made in one place using ProjectCustomizer.CompositeCategoryProvider.Registrations.

Since:

org.netbeans.modules.projectuiapi/1 1.38

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	projectType Project type to associate with, such as org-netbeans-modules-java-j2seproject.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	category Category folder (perhaps multiple components separated by /) in which to place this panel or which is the name of this panel folder.
String	categoryLabel Display name when defining a category folder.
int	position Position of this panel or subfolder within its folder.

Element Detail

projectType

public abstract String projectType

Project type to associate with, such as org-netbeans-modules-java-j2seproject. The folderPath passed to ProjectCustomizer.createCustomizerDialog(String,Lookup,String,ActionListener,HelpCtx) should be Projects/<projectType>/Customizer.

category

public abstract String category

Category folder (perhaps multiple components separated by /) in which to place this panel or which is the name of this panel folder.

Default:

""

categoryLabel

public abstract String categoryLabel

Display name when defining a category folder. Can use pkg.of.Bundle#key_name syntax.

Default:

""

position

public abstract int position

Position of this panel or subfolder within its folder.

Default:

2147483647