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. ProjectCustomizer.CompositeCategoryProvider.Registration.category() can be omitted for a top-level panel; if specified, the panel is placed in the named subcategory. ProjectCustomizer.CompositeCategoryProvider.Registration.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. ProjectCustomizer.CompositeCategoryProvider.Registration.category() must be specified; the last path component is the folder being defined, and any previous components are parent folders. ProjectCustomizer.CompositeCategoryProvider.Registration.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). ProjectCustomizer.CompositeCategoryProvider.Registration.category() and ProjectCustomizer.CompositeCategoryProvider.Registration.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 ProjectCustomizer.CompositeCategoryProvider.Registration.category() of a #1 can match the ProjectCustomizer.CompositeCategoryProvider.Registration.category() of a #2 or #3, and the ProjectCustomizer.CompositeCategoryProvider.Registration.category() of a #2 or #3 preceding the last / can match the ProjectCustomizer.CompositeCategoryProvider.Registration.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