01: /*******************************************************************************
02: * Copyright (c) 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.preferences;
11:
12: import org.eclipse.core.runtime.jobs.Job;
13:
14: /**
15: * IWorkbenchPreferenceContainer is the class that specifies
16: * the workbench specific preferences support.
17: * @since 3.1
18: *
19: */
20: public interface IWorkbenchPreferenceContainer {
21:
22: /**
23: * Open the page specified in the org.eclipse.ui.preferencePage
24: * extension point with id pageId. Apply data to it
25: * when it is opened.
26: * @param preferencePageId String the id specified for a page in
27: * the plugin.xml of its defining plug-in.
28: * @param data The data to be applied to the page when it
29: * opens.
30: * @return boolean <code>true</code> if the page was
31: * opened successfully and data was applied.
32: */
33: public boolean openPage(String preferencePageId, Object data);
34:
35: /**
36: * Get the working copy manager in use by this preference
37: * page container. This IWorkingCopyManager will have
38: * IWorkingCopyManager#applyChanges()
39: * @return IWorkingCopyManager
40: */
41: public IWorkingCopyManager getWorkingCopyManager();
42:
43: /**
44: * Register a job to be run after the container has been closed.
45: * @param job
46: */
47: public void registerUpdateJob(Job job);
48:
49: }
|