javax.ide.property

Class PropertyPage

java.lang.Object

javax.ide.property.PropertyPage

public abstract class PropertyPage
extends java.lang.Object

The PropertyPage interface lets client introduce new property pages for setting IDE and project preferences.

Constructor Summary

Constructors

Constructor and Description
PropertyPage()

Method Summary

Methods

Modifier and Type	Method and Description
abstract GUIPanel	getGUI() Get the root graphical user interface component.
java.lang.String[]	getKeys() Get the property keys this property page uses in the preferences object.
void	onEntry(java.util.prefs.Preferences preferences, Context context) Method called when this page is selected by the user.
void	onExit(java.util.prefs.Preferences preferences, Context context) Method called when users leave this page for another page and when they press the dialog's OK button.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyPage

public PropertyPage()

Method Detail

getGUI

public abstract GUIPanel getGUI()

Get the root graphical user interface component. This component will be hosted by the IDE.

Returns:

the gui for this page. Must not be null.

onEntry

public void onEntry(java.util.prefs.Preferences preferences,
           Context context)

Method called when this page is selected by the user. Implementors are responsible for initializing the GUI with the data provided by the preferences object.

Parameters:

preferences - The data used to initialize the GUI.

context - The current Context.

onExit

public void onExit(java.util.prefs.Preferences preferences,
          Context context)
            throws InvalidPropertyException

Method called when users leave this page for another page and when they press the dialog's OK button. Implementors are responsible for getting the information entered by the user and updating the preferences object.

It's the responsibility of an implementing IDE to take care of ensuring that preference changes are only persisted if the user confirms the changes (e.g. by clicking the OK button vs. the Cancel button in a dialog).

Parameters:

preferences - The data used to initialize the GUI.

context - The current Context.

Throws:

InvalidPropertyException - This exception is thrown when the user tries to leave the page and the information entered does not validate.

getKeys

public java.lang.String[] getKeys()

Get the property keys this property page uses in the preferences object. This method is provided so that IDEs can potentially perform optimizations (e.g. avoid modifying a physical project file until real changes are made)

Returns:

the property keys used by this page.