oracle.ide.config
Class SettingsCustomizations

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.ide.config.SettingsCustomizations

public final class SettingsCustomizations
extends HashStructureAdapter

Provides access to settings customizations registered by a product or role.

Get an instance of this class from SettingsUIRegistry.getCustomizations().

Since:

11.0

Field Summary

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Method Summary

SettingsFieldCustomizations	getFieldCustomizations(java.lang.String fieldIdPath) Returns any customizations provided for a specific field.
java.util.Set<java.lang.String>	getFieldIds(java.lang.String pageId) Returns the set of field ids that have customizations for the specified page id.
java.lang.String	getHelpTopicId(java.lang.String pageId) Returns the help topic id to use for the specified page id.
java.util.Collection<java.lang.String>	getHiddenPages() Returns the ids of all pages that are hidden.

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

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

Method Detail

getFieldIds

public java.util.Set<java.lang.String> getFieldIds(java.lang.String pageId)

Returns the set of field ids that have customizations for the specified page id.

Parameters:

pageId - the id of a page, for example "/preferences/audit". Must not be null, must start with a forward slash.

Returns:

a non-null, unmodifiable, set of ids for fields that have customizations on the specified page. Will return an empty set if the specified page is not found.

Throws:

java.lang.NullPointerException - if pageId is null.

java.lang.IllegalArgumentException - if pageId is badly formatted.

getFieldCustomizations

public SettingsFieldCustomizations getFieldCustomizations(java.lang.String fieldIdPath)

Returns any customizations provided for a specific field.

Parameters:

fieldIdPath - the path of the field identifier. Starts with a forward slash followed by the dialog identifier. Each forward slash separated component is a page identifier, and the path ends with a field identifier. E.g. /preferences/environment/splashscreen. Must not be null. Must contain at least two forward slash characters.

Returns:

customizations for the specified field, or null if none are present.

Throws:

java.lang.NullPointerException - if fieldIdPath is null.

java.lang.IllegalArgumentException - if the path is malformed.

getHiddenPages

public java.util.Collection<java.lang.String> getHiddenPages()

Returns the ids of all pages that are hidden.

Returns:

an immutable collection of Strings, each of which is the id path of a hidden page.

getHelpTopicId

public java.lang.String getHelpTopicId(java.lang.String pageId)

Returns the help topic id to use for the specified page id.

Parameters:

pageId - the id of a page. Must not be null.

Returns:

the help topic to use, according to the active role. Returns null if the role does not select a help topic for this page.