blob: 9cc4a93fb11ddc326a0dcf59f11e260f0c102b0b (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
/*******************************************************************************
* Copyright (c) 2000, 2007 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.workingset;
import java.io.*;
/**
* The working set manager stores help working sets. Working sets are persisted
* whenever one is added or removed.
*
* @since 3.0
*/
public interface IHelpWorkingSetManager {
public AdaptableTocsArray getRoot();
/**
* Adds a new working set and saves it
*/
public void addWorkingSet(WorkingSet workingSet) throws IOException;
/**
* Creates a new working set
*/
public WorkingSet createWorkingSet(String name,
AdaptableHelpResource[] elements);
/**
* Returns a working set by name
*
*/
public WorkingSet getWorkingSet(String name);
/**
* Implements IWorkingSetManager.
*
* @see org.eclipse.ui.IWorkingSetManager#getWorkingSets()
*/
public WorkingSet[] getWorkingSets();
/**
* Removes specified working set
*/
public void removeWorkingSet(WorkingSet workingSet);
/**
* Persists all working sets. Should only be called by the webapp working
* set dialog.
*
* @param changedWorkingSet
* the working set that has changed
*/
public void workingSetChanged(WorkingSet changedWorkingSet)
throws IOException;
public AdaptableToc getAdaptableToc(String href);
public AdaptableTopic getAdaptableTopic(String id);
public String getCurrentWorkingSet();
public void setCurrentWorkingSet(String workingSet);
}
|