org.netbeans.spi.project.ui.support

Interface ProjectCustomizer.CompositeCategoryProvider

Enclosing class:

ProjectCustomizer

public static interface ProjectCustomizer.CompositeCategoryProvider

Interface for creation of Customizer categories and their respective UI panels. Used by ProjectCustomizer.createCustomizerDialog(String,Lookup,String,ActionListener,HelpCtx).

The panel/category created by the provider can get notified that the customizer got closed by setting an ActionListener to ProjectCustomizer.Category.setOkButtonListener(java.awt.event.ActionListener).

Implementations can be registered using ProjectCustomizer.CompositeCategoryProvider.Registration. Otherwise they can be manually registered in a tree structure in the system filesystem. UI Component can be defined for category folder that is represented as node with subnodes in the category tree of project customizer. The file that defines the instance class in layer for such category must be named Self. Such a provider will not have the ProjectCustomizer.CompositeCategoryProvider.createCategory(org.openide.util.Lookup) method called (display name will be taken from the folder), but will have the children created by the infrastructure based on the folder content. For details and usage see issue #91276.

Since:

org.netbeans.modules.projectuiapi/1 1.22

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ProjectCustomizer.CompositeCategoryProvider.Registration Used to register customizer panels.
static interface	ProjectCustomizer.CompositeCategoryProvider.Registrations Used in case multiple registrations are needed in one place.

Method Summary

Modifier and Type	Method and Description
ProjectCustomizer.Category	createCategory(Lookup context) create the Category instance for the given project customizer context.
JComponent	createComponent(ProjectCustomizer.Category category, Lookup context) create the UI component for given category and context.

Method Detail

createCategory

ProjectCustomizer.Category createCategory(Lookup context)

create the Category instance for the given project customizer context.

Parameters:

context - Lookup instance passed from project The content is up to the project type, please consult documentation for the project type you want to integrate your panel into.

Returns:

A category instance, can be null, in which case no category and no panels are created for given context. The instance is expected to have no subcategories.

createComponent

JComponent createComponent(ProjectCustomizer.Category category,
                           Lookup context)

create the UI component for given category and context. The panel/category created by the provider can get notified that the customizer got closed by setting an ActionListener to ProjectCustomizer.Category.setOkButtonListener(java.awt.event.ActionListener).

Parameters:

category - Category instance that was created in the createCategory method.

context - Lookup instance passed from project The content is up to the project type, please consult documentation for the project type you want to integrate your panel into.