oracle.ide.config

Class SettingsPageCustomizationHelper

java.lang.Object

oracle.ide.config.SettingsPageCustomizationHelper

public final class SettingsPageCustomizationHelper
extends java.lang.Object

A helper for handling settings page customization. This helper can be used to automatically enable/disable and show/hide components based on customization information specified in extension hooks.

To obtain an instance of this class, call SettingsUIRegistry.getHelper( Traversable, String ).

Since:

11.0

Method Summary

Methods

Modifier and Type	Method and Description
void	customizeComponents() Customizes the components in the traversable this helper is associated with.
SettingsFieldCustomizations	getCustomizations(java.lang.String fieldId) Convenience method that gets the cutomizations (if any) for the specified field id.
void	setFieldId(javax.swing.JComponent c, java.lang.String fieldId) Associates a component with a field id.

Methods inherited from class java.lang.Object

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

Method Detail

setFieldId

public void setFieldId(javax.swing.JComponent c,
              java.lang.String fieldId)

Associates a component with a field id. You can assign the same field id to multiple components (for example, a label and a text field).

Parameters:

c - a component. Must not be null.

fieldId - a field id

customizeComponents

public void customizeComponents()

Customizes the components in the traversable this helper is associated with. This will: enable / disable any components which have customization info hide / show any components which have customization info Prior to calling this method, you should associate all components you want to customize with their field ids using the setFieldId( JComponent, String) method.

Note that this method does not handle setting default values or hints. It is up to the traversable to deal with that.

getCustomizations

public SettingsFieldCustomizations getCustomizations(java.lang.String fieldId)

Convenience method that gets the cutomizations (if any) for the specified field id.

Parameters:

fieldId - a simple field id in this page (not a full path).

Returns:

the customizations for this field, or null if there are none.