| org.eclipse.ui.texteditor.spelling.ISpellingPreferenceBlock
All known Subclasses: org.eclipse.ui.internal.texteditor.spelling.EmptySpellingPreferenceBlock,
| ISpellingPreferenceBlock | | public interface ISpellingPreferenceBlock (Code) | | 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 |
| canPerformOk | | boolean canPerformOk()(Code) | | Returns true iff
ISpellingPreferenceBlock.performOk() may be called. A
preference block may, for example, return false if
some user supplied value is not valid (and validation is an expensive
operation, use
IPreferenceStatusMonitor to report validation
results on-the-fly). A preference block may also request additional
user input and cancel the initiated
ISpellingPreferenceBlock.performOk() , 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
ISpellingPreferenceBlock.performOk() without a preceding call to this
method.
true iff performOk() may becalled |
| createControl | | Control createControl(Composite parent)(Code) | | Creates the control that will be displayed on the preference page.
Parameters:
parent - the parent composite to which to add the preferences control the control that was added to parent |
| dispose | | void dispose()(Code) | | Called when the preference page is being disposed. Implementations should
free any resources they are holding on to.
|
| initialize | | void initialize(IPreferenceStatusMonitor statusMonitor)(Code) | | 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 |
| performDefaults | | void performDefaults()(Code) | | Called when the Defaults button is pressed on the
preference page. Implementation should reset any preference settings to
their default values and adjust the controls accordingly.
|
| performOk | | void performOk()(Code) | | Called when the OK button is pressed on the preference
page. Implementations should commit the configured preference
settings into their form of preference storage.
|
| performRevert | | void performRevert()(Code) | | 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.
|
| setEnabled | | void setEnabled(boolean enabled)(Code) | | Sets the enablement of all controls of this preference block.
Parameters:
enabled - true iff the controls should be enabled |
|
|