KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > preference > IPreferencePageContainer


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/

11 package org.eclipse.jface.preference;
12
13 /**
14  * An interface used by a preference page to talk to
15  * its dialog.
16  */

17 public interface IPreferencePageContainer {
18     /**
19      * Returns the preference store.
20      *
21      * @return the preference store, or <code>null</code> if none
22      */

23     public IPreferenceStore getPreferenceStore();
24
25     /**
26      * Adjusts the enable state of the OK
27      * button to reflect the state of the currently active
28      * page in this container.
29      * <p>
30      * This method is called by the container itself
31      * when its preference page changes and may be called
32      * by the page at other times to force a button state
33      * update.
34      * </p>
35      */

36     public void updateButtons();
37
38     /**
39      * Updates the message (or error message) shown in the message line to
40      * reflect the state of the currently active page in this container.
41      * <p>
42      * This method is called by the container itself
43      * when its preference page changes and may be called
44      * by the page at other times to force a message
45      * update.
46      * </p>
47      */

48     public void updateMessage();
49
50     /**
51      * Updates the title to reflect the state of the
52      * currently active page in this container.
53      * <p>
54      * This method is called by the container itself
55      * when its page changes and may be called
56      * by the page at other times to force a title
57      * update.
58      * </p>
59      */

60     public void updateTitle();
61 }
62
Popular Tags