Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.2.0)

E17493-03


javax.ide.property
Class PropertyPageRegistry

java.lang.Object
  extended by javax.ide.Service
      extended by javax.ide.property.PropertyPageRegistry


public abstract class PropertyPageRegistry
extends Service

The 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.


Field Summary
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 Summary
PropertyPageRegistry()
           

 

Method Summary
 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.

 

Methods inherited from class javax.ide.Service
getService, initialize, resetAllServices

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

PROJECT_CLASS_NAME

public static final java.lang.String PROJECT_CLASS_NAME
Constant identifying the project class name.
See Also:
Constant Field Values

IDE_CLASS_NAME

public static final java.lang.String IDE_CLASS_NAME
Constant identifying the IDE class name.
See Also:
Constant Field Values

Constructor Detail

PropertyPageRegistry

public PropertyPageRegistry()

Method Detail

getPropertyPages

public abstract PropertyPage[] getPropertyPages(java.lang.String objectClassName)
Get the pages associated with the specified objectClassName.
Parameters:
objectClassName - The object class whose properties will be edited by the returned property pages.
Returns:
The property pages associated with the specified objectClassName.

getProjectPropertyPages

public final PropertyPage[] getProjectPropertyPages()
Get the project property pages. This method just calls the getPropertyPages(java.lang.String) method passing as argument PROJECT_CLASS_NAME.
Returns:
An array of property pages associated with a project. Must not return null, may return an empty array.

getIDEPropertyPages

public final PropertyPage[] getIDEPropertyPages()
Get the IDE property pages. This method just calls the getPropertyPages(java.lang.String) method passing as argument IDE_CLASS_NAME.
Returns:
An array of property pages associated with the IDE.

getPropertyPageRegistry

public static PropertyPageRegistry getPropertyPageRegistry()
Get the property page registry implementation for this IDE.
Returns:
the property page registry implementation registered with this IDE.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.2.0)

E17493-03


Copyright © 1997, 2012, Oracle. All rights reserved.