KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > ILocalWorkingSetManager


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 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.ui;
12
13 /**
14  * A local working set manager can be used to manage a set of
15  * working sets independently from the working sets managed by
16  * the global working set manager. A local working set manager
17  * can be saved and restored using the methods <code>saveState</code>
18  * and <code>restoreState</code>. A new local working set manager can be created
19  * using {@link org.eclipse.ui.IWorkbench#createLocalWorkingSetManager()}.
20  * Clients of local working set managers are responsible for calling
21  * {@link IWorkingSetManager#dispose()} when the working sets it manages
22  * are no longer needed.
23  * <p>
24  * This interface is not intended to be implemented or extended by clients.
25  * </p>
26  *
27  * @see org.eclipse.ui.IWorkbench#createLocalWorkingSetManager()
28  * @since 3.1
29  */
30 public interface ILocalWorkingSetManager extends IWorkingSetManager {
31
32     /**
33      * Saves the state of the working set manager to the given
34      * memento.
35      *
36      * @param memento the memento to save the state to
37      */
38     public void saveState(IMemento memento);
39     
40     /**
41      * Restores the state of the working set manager from the given
42      * memento. The method can only be called as long as the working
43      * set manager is still empty.
44      *
45      * @param memento the memento to restore the state from
46      */
47     public void restoreState(IMemento memento);
48 }
49
Popular Tags