ITriggerPoint


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