Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.ide.property
Class PropertyPage  view PropertyPage download PropertyPage.java

java.lang.Object
  extended byjavax.ide.property.PropertyPage
All Implemented Interfaces:
javax.ide.view.Viewable

public abstract class PropertyPage
extends java.lang.Object
implements javax.ide.view.Viewable

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


Field Summary
 
Fields inherited from interface javax.ide.view.Viewable
PROP_ICON_PATH, PROP_LABEL, PROP_VISIBLE
 
Constructor Summary
PropertyPage()
           
 
Method Summary
abstract  javax.ide.view.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, javax.ide.command.Context context)
          Method called when this page is selected by the user.
 void onExit(java.util.prefs.Preferences preferences, javax.ide.command.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
 
Methods inherited from interface javax.ide.view.Viewable
addPropertyChangeListener, getIcon, getLabel, getToolTip, isVisible, removePropertyChangeListener, toString
 

Constructor Detail

PropertyPage

public PropertyPage()
Method Detail

getGUI

public abstract javax.ide.view.GUIPanel getGUI()
Get the root graphical user interface component. This component will be hosted by the IDE.


onEntry

public void onEntry(java.util.prefs.Preferences preferences,
                    javax.ide.command.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.


onExit

public void onExit(java.util.prefs.Preferences preferences,
                   javax.ide.command.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.


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)