IHelpWorkingSetManager


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.help.internal.workingset;
12  
13  import java.io.*;
14  
15  /**
16   * The working set manager stores help working sets. Working sets are persisted
17   * whenever one is added or removed.
18   * 
19   * @since 3.0
20   */
21  public interface IHelpWorkingSetManager {
22  
23      public AdaptableTocsArray getRoot();
24      /**
25       * Adds a new working set and saves it
26       */
27      public void addWorkingSet(WorkingSet workingSet) throws IOException;
28  
29      /**
30       * Creates a new working set
31       */
32      public WorkingSet createWorkingSet(String   name,
33              AdaptableHelpResource[] elements);
34  
35      /**
36       * Returns a working set by name
37       *  
38       */
39      public WorkingSet getWorkingSet(String   name);
40  
41      /**
42       * Implements IWorkingSetManager.
43       * 
44       * @see org.eclipse.ui.IWorkingSetManager#getWorkingSets()
45       */
46      public WorkingSet[] getWorkingSets();
47  
48      /**
49       * Removes specified working set
50       */
51      public void removeWorkingSet(WorkingSet workingSet);
52  
53      /**
54       * Persists all working sets. Should only be called by the webapp working
55       * set dialog.
56       * 
57       * @param changedWorkingSet
58       *            the working set that has changed
59       */
60      public void workingSetChanged(WorkingSet changedWorkingSet)
61              throws IOException;
62  
63      public AdaptableToc getAdaptableToc(String   href);
64  
65      public AdaptableTopic getAdaptableTopic(String   id);
66  
67      public String   getCurrentWorkingSet();
68  
69      public void setCurrentWorkingSet(String   workingSet);
70  }
71
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags