oracle.ide.config

Class SettingsUIRegistry

java.lang.Object

oracle.ide.config.SettingsUIRegistry

public final class SettingsUIRegistry
extends java.lang.Object

The settings UI registry provides access to information gathered from extension manifests and roles about settings UI.

Since:

11.0

Method Summary

Methods

Modifier and Type	Method and Description
static SettingsCustomizations	getCustomizations() Returns a SettingsCustomizations object which provides access to customizations to settings UI installed by roles or extensions.
static java.util.Collection<Navigable>	getExtensionNavigables(java.lang.String dialogId) Returns a collection of Navigables for all pages registered as direct children of the specified dialog in the extension manifests of loaded extensions.
static SettingsPageCustomizationHelper	getHelper(Traversable t, java.lang.String pageId) Returns a helper that can be used to automatically enable / disable and show / hide components on a page based on customization information.
static java.lang.String	getObjectLabel(java.lang.String dialogId) Returns the object label for the specified dialog ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getHelper

public static SettingsPageCustomizationHelper getHelper(Traversable t,
                                        java.lang.String pageId)

Returns a helper that can be used to automatically enable / disable and show / hide components on a page based on customization information.

Parameters:

t - the traversable the helper will customize.

pageId - the id path of the page to customize.

Returns:

a customization helper instance.

getCustomizations

public static final SettingsCustomizations getCustomizations()

Returns a SettingsCustomizations object which provides access to customizations to settings UI installed by roles or extensions.

Returns:

an instance of SettingsCustomizations.

getExtensionNavigables

public static final java.util.Collection<Navigable> getExtensionNavigables(java.lang.String dialogId)

Returns a collection of Navigables for all pages registered as direct children of the specified dialog in the extension manifests of loaded extensions.

The returned navigables are prepopulated with all children that are registered via extension manifests.

The returned collection of Navigables does not include any navigables registered programmatically with

Parameters:

dialogId - the id of a dialog registered in the settings-ui-hook. Must not be null.

Returns:

an immutable collection of navigables registered as direct children of the specified dialog. If none are registered, returns an empty collection.

Throws:

java.lang.NullPointerException - if dialogId is null.

getObjectLabel

public static final java.lang.String getObjectLabel(java.lang.String dialogId)

Returns the object label for the specified dialog ID.