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.jface.dialogs;
11:
12: /**
13: * Minimal interface to a page change provider. Used for dialogs which can
14: * switch between multiple pages.
15: *
16: * @since 3.1
17: */
18: public interface IPageChangeProvider {
19: /**
20: * Returns the currently selected page in the dialog.
21: *
22: * @return the selected page in the dialog or <code>null</code> if none is
23: * selected. The type may be domain specific. In
24: * the JFace provided dialogs this will be an instance of
25: * <code>IDialogPage</code>.
26: */
27: Object getSelectedPage();
28:
29: /**
30: * Adds a listener for page changes in this page change provider. Has no
31: * effect if an identical listener is already registered.
32: *
33: * @param listener
34: * a page changed listener
35: */
36: void addPageChangedListener(IPageChangedListener listener);
37:
38: /**
39: * Removes the given page change listener from this page change provider.
40: * Has no effect if an identical listener is not registered.
41: *
42: * @param listener
43: * a page changed listener
44: */
45: void removePageChangedListener(IPageChangedListener listener);
46:
47: }
|