IMutableCommandManager


1   /*******************************************************************************
2    * Copyright (c) 2000, 2004 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials 
4    * are made available under the terms of the Common Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/cpl-v10.html
7    * 
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  
12  package org.eclipse.ui.internal.commands;
13  
14  import java.util.Map  ;
15  
16  import org.eclipse.ui.commands.ICommandManager;
17  
18  /**
19   * <p>
20   * An instance of this interface allows clients to manage commands, as defined
21   * by the extension point <code>org.eclipse.ui.commands</code>.  This interface
22   * allows full control over the command manager -- changing the handlers,
23   * contexts, locale or platform to arbitrary values.
24   * </p>
25   * <p>
26   * This interface is not intended to be extended or implemented by clients.
27   * </p>
28   * 
29   * @since 3.0
30   * @see CommandManagerFactory
31   */
32  public interface IMutableCommandManager extends ICommandManager {
33     
34      /**
35       * Sets the map of identifiers to active contexts. The mapping represents
36       * the hierarchical structure of the contexts.
37       * 
38       * @param activeContextIds
39       *            a map of child context identifiers to parent context
40       *            identifiers -- representing the hierarchy of active contexts.
41       *            This tree may be empty, but it must not be <code>null</code>.
42       *            If this tree is not empty, it must only contain instances of
43       *            <code>String</code>.
44       */
45      void setActiveContextIds(Map   activeContextIds);
46      
47      /**
48       * Sets the active key configuration.
49       * 
50       * @param activeKeyConfigurationId
51       *            the active key configuration; must not be <code>null</code>.
52       */
53      void setActiveKeyConfigurationId(String   activeKeyConfigurationId);
54  
55      /**
56       * Sets the active locale. The locale can be any arbitrary string, but is
57       * typically the locale returned from {@link java.util.Locale#getDefault()}.
58       * 
59       * @param activeLocale
60       *            the active locale; must not be <code>null</code>.
61       */
62      void setActiveLocale(String   activeLocale);
63  
64      /**
65       * Sets the active platform.  The locale can be any arbitrary string, but is
66       * typically the locale returned from {@link org.eclipse.swt.SWT#getPlatform()}.
67       * 
68       * @param activePlatform
69       *            the active platform; must not be <code>null</code>.
70       */
71      void setActivePlatform(String   activePlatform);
72  
73      /**
74       * Sets the map of handlers by command identifiers.
75       * 
76       * @param handlersByCommandId
77       *            the map of handlers by command identifiers. This map may be
78       *            empty, but it must not be <code>null</code>. If this map is
79       *            not empty, its keys must be instances of <code>String</code>
80       *            and its values must be instances of <code>IHandler</code>.
81       */
82      void setHandlersByCommandId(Map   handlersByCommandId);
83  }
84
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags