01: /*******************************************************************************
02: * Copyright (c) 2004, 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.activities;
11:
12: import java.util.Set;
13:
14: /**
15: * Contains a collection of known trigger points. An instance of this class may
16: * be obtained from
17: * {@link org.eclipse.ui.activities.IWorkbenchActivitySupport#getTriggerPointManager()}.
18: * <p>
19: * This interface is not intended to be extended or implemented by clients.
20: * </p>
21: *
22: * @see org.eclipse.ui.activities.ITriggerPoint
23: * @since 3.1
24: */
25: public interface ITriggerPointManager {
26:
27: /**
28: * Constant representing the id of an unknown trigger point. Used by clients
29: * of {@link WorkbenchActivityHelper#allowUseOf(Object)} for trigger point
30: * determination logic.
31: */
32: public static final String UNKNOWN_TRIGGER_POINT_ID = "org.eclipse.ui.internal.UnknownTriggerPoint"; //$NON-NLS-1$
33:
34: /**
35: * Return the trigger point with the given id.
36: *
37: * @param id the trigger point id
38: * @return the trigger point or <code>null</code>
39: */
40: ITriggerPoint getTriggerPoint(String id);
41:
42: /**
43: * Return the set of defined trigger point ids.
44: *
45: * @return the defined ids. Never <code>null</code> but may be empty.
46: */
47: Set getDefinedTriggerPointIds();
48: }
|