Interface ISpellingPreferenceBlock
public interface ISpellingPreferenceBlock
Contributors to the
org.eclipse.ui.texteditor.spellingEngine
extension point can specify an implementation of this interface to be
displayed on the spelling preference page, if the corresponding engine is
selected.
This interface is intended to be implemented by clients.
- Since:
- 3.1
-
Method Summary
Modifier and TypeMethodDescriptionbooleanReturnstrueiffperformOk()may be called.createControl(Composite parent) Creates the control that will be displayed on the preference page.voiddispose()Called when the preference page is being disposed.voidinitialize(IPreferenceStatusMonitor statusMonitor) Called after creating the control.voidCalled when theDefaultsbutton is pressed on the preference page.voidCalled when theOKbutton is pressed on the preference page.voidCalled when the user decided to dismiss all changes.voidsetEnabled(boolean enabled) Sets the enablement of all controls of this preference block.
-
Method Details
-
createControl
Creates the control that will be displayed on the preference page.- Parameters:
parent- the parent composite to which to add the preferences control- Returns:
- the control that was added to
parent
-
initialize
Called after creating the control. Implementations should load the preferences values and update the controls accordingly. A status monitor is supplied to allow for status reporting to the user.- Parameters:
statusMonitor- the status monitor
-
setEnabled
void setEnabled(boolean enabled) Sets the enablement of all controls of this preference block.- Parameters:
enabled-trueiff the controls should be enabled
-
canPerformOk
boolean canPerformOk()ReturnstrueiffperformOk()may be called. A preference block may, for example, returnfalseif some user supplied value is not valid (and validation is an expensive operation, useIPreferenceStatusMonitorto report validation results on-the-fly). A preference block may also request additional user input and cancel the initiatedperformOk(), based on that input.Note that this method is guaranteed to be called only on an enabled spelling engine, any spelling engine should be prepared to store its settings on
performOk()without a preceding call to this method.- Returns:
trueiffperformOk()may be called
-
performOk
void performOk()Called when theOKbutton is pressed on the preference page. Implementations should commit the configured preference settings into their form of preference storage. -
performDefaults
void performDefaults()Called when theDefaultsbutton is pressed on the preference page. Implementation should reset any preference settings to their default values and adjust the controls accordingly. -
performRevert
void performRevert()Called when the user decided to dismiss all changes. Implementation should reset any working copy changes to their previous values and adjust the controls accordingly. -
dispose
void dispose()Called when the preference page is being disposed. Implementations should free any resources they are holding on to.
-