public abstract class PropertyPageRegistry extends Service
PropertyPageRegistry
is the registry of information
describing what extension specific property pages have been added to an IDE.
Extensions register property page information in the extension manifest using the property-pages-hook tag. The property pages hook allows extension to declare property pages for the IDE and project preferences. Extension use the property-page object-class tag to specify the object class for which the pages are declared. For example, if the pages are for a project, extension should specify javax.ide.model.Project as the object class. If the pages are for the IDE, extension should specify javax.ide.IDE as the object class. Pages registered for the project and IDE are shown when the project and IDE preference dialogs are displayed.
Extensions can also use this registry * to associate pages with any object class. Doing so makes them responsiblefor providing the graphical user interface to display these pages.
Propety pages are associated with an object class. In general, extension writers can define pages for the IDE and/or a project.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
IDE_CLASS_NAME
Constant identifying the IDE class name.
|
static java.lang.String |
PROJECT_CLASS_NAME
Constant identifying the project class name.
|
Constructor and Description |
---|
PropertyPageRegistry() |
Modifier and Type | Method and Description |
---|---|
PropertyPage[] |
getIDEPropertyPages()
Get the IDE property pages.
|
PropertyPage[] |
getProjectPropertyPages()
Get the project property pages.
|
static PropertyPageRegistry |
getPropertyPageRegistry()
Get the property page registry implementation for this IDE.
|
abstract PropertyPage[] |
getPropertyPages(java.lang.String objectClassName)
Get the pages associated with the specified
objectClassName . |
cloneLoadedServices, getService, initialize, resetAllServices, setLoadedServices
public static final java.lang.String PROJECT_CLASS_NAME
public static final java.lang.String IDE_CLASS_NAME
public abstract PropertyPage[] getPropertyPages(java.lang.String objectClassName)
objectClassName
.objectClassName
- The object class whose properties will be edited by
the returned property pages.objectClassName
.public final PropertyPage[] getProjectPropertyPages()
getPropertyPages(java.lang.String)
method passing as argument
PROJECT_CLASS_NAME
.public final PropertyPage[] getIDEPropertyPages()
getPropertyPages(java.lang.String)
method passing as argument IDE_CLASS_NAME
.public static PropertyPageRegistry getPropertyPageRegistry()