01: /*******************************************************************************
02: * Copyright (c) 2000, 2005 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.texteditor.spelling;
11:
12: import org.eclipse.swt.widgets.Composite;
13: import org.eclipse.swt.widgets.Control;
14:
15: /**
16: * Contributors to the <code>org.eclipse.ui.texteditor.spellingEngine</code>
17: * extension point can specify an implementation of this interface to be
18: * displayed on the spelling preference page, if the corresponding engine is
19: * selected.
20: * <p>
21: * This interface is intended to be implemented by clients.
22: * </p>
23: *
24: * @since 3.1
25: */
26: public interface ISpellingPreferenceBlock {
27:
28: /**
29: * Creates the control that will be displayed on the preference page.
30: *
31: * @param parent the parent composite to which to add the preferences control
32: * @return the control that was added to <code>parent</code>
33: */
34: Control createControl(Composite parent);
35:
36: /**
37: * Called after creating the control. Implementations should load the
38: * preferences values and update the controls accordingly. A status
39: * monitor is supplied to allow for status reporting to the user.
40: *
41: * @param statusMonitor the status monitor
42: */
43: void initialize(IPreferenceStatusMonitor statusMonitor);
44:
45: /**
46: * Sets the enablement of all controls of this preference block.
47: *
48: * @param enabled <code>true</code> iff the controls should be enabled
49: */
50: void setEnabled(boolean enabled);
51:
52: /**
53: * Returns <code>true</code> iff {@link #performOk()} may be called. A
54: * preference block may, for example, return <code>false</code> if
55: * some user supplied value is not valid (and validation is an expensive
56: * operation, use {@link IPreferenceStatusMonitor} to report validation
57: * results on-the-fly). A preference block may also request additional
58: * user input and cancel the initiated {@link #performOk()}, based on
59: * that input.
60: * <p>
61: * Note that this method is guaranteed to be called only on an enabled
62: * spelling engine, any spelling engine should be prepared to store its
63: * settings on {@link #performOk()} without a preceding call to this
64: * method.
65: * </p>
66: *
67: * @return <code>true</code> iff <code>performOk()</code> may be
68: * called
69: */
70: boolean canPerformOk();
71:
72: /**
73: * Called when the <code>OK</code> button is pressed on the preference
74: * page. Implementations should commit the configured preference
75: * settings into their form of preference storage.
76: */
77: void performOk();
78:
79: /**
80: * Called when the <code>Defaults</code> button is pressed on the
81: * preference page. Implementation should reset any preference settings to
82: * their default values and adjust the controls accordingly.
83: */
84: void performDefaults();
85:
86: /**
87: * Called when the user decided to dismiss all changes. Implementation
88: * should reset any working copy changes to their previous values and
89: * adjust the controls accordingly.
90: */
91: void performRevert();
92:
93: /**
94: * Called when the preference page is being disposed. Implementations should
95: * free any resources they are holding on to.
96: */
97: void dispose();
98:
99: }
|