|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
boolean |
canPerformOk()
Returns true iff performOk() may be called. |
Control |
createControl(Composite parent)
Creates the control that will be displayed on the preference page. |
void |
dispose()
Called when the preference page is being disposed. |
void |
initialize(IPreferenceStatusMonitor statusMonitor)
Called after creating the control. |
void |
performDefaults()
Called when the Defaults button is pressed on the
preference page. |
void |
performOk()
Called when the OK button is pressed on the preference
page. |
void |
performRevert()
Called when the user decided to dismiss all changes. |
void |
setEnabled(boolean enabled)
Sets the enablement of all controls of this preference block. |
Method Detail |
public Control createControl(Composite parent)
parent
- the parent composite to which to add the preferences control
parent
public void initialize(IPreferenceStatusMonitor statusMonitor)
statusMonitor
- the status monitorpublic void setEnabled(boolean enabled)
enabled
- true
iff the controls should be enabledpublic boolean canPerformOk()
true
iff 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 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 performOk()
without a preceding call to this
method.
true
iff performOk()
may be
calledpublic void performOk()
OK
button is pressed on the preference
page. Implementations should commit the configured preference
settings into their form of preference storage.
public void performDefaults()
Defaults
button is pressed on the
preference page. Implementation should reset any preference settings to
their default values and adjust the controls accordingly.
public void performRevert()
public void dispose()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.