Workaround for feature request #1154254 (sticky browser URL) that solves bug #1827766...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / preferences / IPreferenceConfigurationBlock.java
1 /*******************************************************************************
2  * Copyright (c) 2000, 2003 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  *
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package net.sourceforge.phpdt.internal.ui.preferences;
13
14 import org.eclipse.swt.widgets.Composite;
15 import org.eclipse.swt.widgets.Control;
16
17 /**
18  * Interface for preference configuration blocks which can either be wrapped by
19  * a
20  * {@link net.sourceforge.phpdt.internal.ui.preferences.AbstractConfigurationBlockPreferencePage}
21  * or be included some preference page.
22  * <p>
23  * Clients may implement this interface.
24  * </p>
25  * 
26  * @since 3.0
27  */
28 public interface IPreferenceConfigurationBlock {
29
30         /**
31          * Creates the preference control.
32          * 
33          * @param parent
34          *            the parent composite to which to add the preferences control
35          * @return the control that was added to <code>parent</code>
36          */
37         Control createControl(Composite parent);
38
39         /**
40          * Called after creating the control. Implementations should load the
41          * preferences values and update the controls accordingly.
42          */
43         void initialize();
44
45         /**
46          * Called when the <code>OK</code> button is pressed on the preference
47          * page. Implementations should commit the configured preference settings
48          * into their form of preference storage.
49          */
50         void performOk();
51
52         /**
53          * Called when the <code>Defaults</code> button is pressed on the
54          * preference page. Implementation should reset any preference settings to
55          * their default values and adjust the controls accordingly.
56          */
57         void performDefaults();
58
59         /**
60          * Called when the preference page is being disposed. Implementations should
61          * free any resources they are holding on to.
62          */
63         void dispose();
64 }