LPEX
3.6.5

com.ibm.lpex.alef.preferences
Class LpexFieldEditorPreferencePage

java.lang.Object
  extended by FieldEditorPreferencePage
      extended by com.ibm.lpex.alef.preferences.LpexFieldEditorPreferencePage
Direct Known Subclasses:
BlockPreferencePage, ComparePreferencePage, ControlsPreferencePage, FindTextPreferencePage, LpexBasePreferencePage, PrintPreferencePage, SavePreferencePage, SequenceNumbersPreferencePage, SourceEncodingPreferencePage, TabsPreferencePage, UserProfilePreferencePage, ViewParserPreferencePage

public abstract class LpexFieldEditorPreferencePage
extends FieldEditorPreferencePage

LPEX abstract preference page that hosts field editors. It implements a series of common methods used by LPEX preference pages. Method contributeButtons() adds a "Reset" button, which restores the initial settings in effect when the preference page came up.

Like Eclipse's FieldEditorPreferencePage, subclasses must implement the createFieldEditors() method, and override createLayout() if a special layout of the field editors is needed.


Constructor Summary
protected LpexFieldEditorPreferencePage(String title, int style)
          Constructor for a preference page with the given title and style, and no image.
 
Method Summary
protected  void contributeButtons(Composite buttonBar)
          The LpexFieldEditorPreferencePage implementation of this method contributes a "Reset" button.
protected  void fieldEditorsCreated()
          Hook for extenders of certain LPEX preference pages.
 void init(IWorkbench workbench)
          Initializes this preference page for the given workbench.
protected  void performReset()
          "Reset" button pressed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LpexFieldEditorPreferencePage

protected LpexFieldEditorPreferencePage(String title,
                                        int style)
Constructor for a preference page with the given title and style, and no image.

Parameters:
style - either GRID or FLAT
Method Detail

contributeButtons

protected void contributeButtons(Composite buttonBar)
The LpexFieldEditorPreferencePage implementation of this method contributes a "Reset" button. Method performReset() is called when this button is selected.

Parameters:
buttonBar - the preference-page button bar
See Also:
PreferencePage, performReset()

performReset

protected void performReset()
"Reset" button pressed. The LpexFieldEditorPreferencePage implementation of this method does nothing. Override to restore the initial settings of the preference page.

See Also:
contributeButtons(Composite)

init

public void init(IWorkbench workbench)
Initializes this preference page for the given workbench. This method, defined by IWorkbenchPreferencePage, is called automatically when the preference page defined in plugin.xml is being created and initialized.

The LpexFieldEditorPreferencePage implementation of this method does nothing.


fieldEditorsCreated

protected void fieldEditorsCreated()
Hook for extenders of certain LPEX preference pages. Called after createFieldEditors(), it allows the subclass to disable selected fields in the preference page.

The LpexFieldEditorPreferencePage implementation of this method does nothing.

See Also:
#createFieldEditors

LPEX
3.6.5

Copyright © 2012 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.