new Preferences tree
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / ui / text / folding / IJavaFoldingPreferenceBlock.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 package net.sourceforge.phpdt.ui.text.folding;
12
13 import org.eclipse.swt.widgets.Composite;
14 import org.eclipse.swt.widgets.Control;
15
16
17 /**
18  * Contributors to the <code>net.sourceforge.phpdt.ui.foldingStructureProvider</code> extension point
19  * can specify an implementation of this interface to be displayed on the Java &gt; Editor &gt; Folding
20  * preference page.
21  * <p>
22  * Clients may implement this interface.
23  * </p>
24  * 
25  * @since 3.0
26  */
27 public interface IJavaFoldingPreferenceBlock {
28
29         /**
30          * Creates the control that will be displayed on the Java Editor folding
31          * preference page.
32          * 
33          * @param parent the parent composite to which to add the preferences control
34          * @return the control that was added to <code>parent</code> 
35          */
36         Control createControl(Composite parent);
37
38         /**
39          * Called after creating the control. Implementations should load the 
40          * preferences values and update the controls accordingly.
41          */
42         void initialize();
43
44         /**
45          * Called when the <code>OK</code> button is pressed on the preference
46          * page. Implementations should commit the configured preference settings
47          * into their form of preference storage.
48          */
49         void performOk();
50
51         /**
52          * Called when the <code>Defaults</code> button is pressed on the
53          * preference page. Implementation should reset any preference settings to
54          * their default values and adjust the controls accordingly.
55          */
56         void performDefaults();
57
58         /**
59          * Called when the preference page is being disposed. Implementations should
60          * free any resources they are holding on to.
61          */
62         void dispose();
63
64 }