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: /**
13: * A trigger point represents a place within the Workbench that has the
14: * potential to enable activities. Instances of this class may be obtained from
15: * {@link org.eclipse.ui.activities.ITriggerPointManager#getTriggerPoint(String)}.
16: * Instances of this interface are passed as a parameter to
17: * {@link org.eclipse.ui.activities.ITriggerPointAdvisor#allow(ITriggerPoint, IIdentifier)}
18: * and may be used by the advisor to determine policy.
19: * <p>
20: * This interface is not intended to be extended or implemented by clients.
21: * </p>
22: *
23: * @see org.eclipse.ui.activities.ITriggerPointAdvisor
24: * @see org.eclipse.ui.activities.ITriggerPointManager
25: * @since 3.1
26: */
27: public interface ITriggerPoint {
28:
29: /**
30: * The interactive hint key. Value <code>"interactive"</code>.
31: */
32: public static final String HINT_INTERACTIVE = "interactive"; //$NON-NLS-1$
33:
34: /**
35: * Return the id of this trigger point.
36: *
37: * @return the id
38: */
39: String getId();
40:
41: /**
42: * Return the hint with the given key defined on this trigger point.
43: *
44: * @param key the hint key
45: * @return the hint
46: */
47: String getStringHint(String key);
48:
49: /**
50: * Return the hint with the given key defined on this trigger point as
51: * interpreted as a <code>boolean</code>.
52: *
53: * @param key the hint key
54: * @return the hint
55: * @see Boolean#valueOf(java.lang.String)
56: */
57: boolean getBooleanHint(String key);
58: }
|