Eclipse Plug-in Developer Guide (Galileo) - ITriggerPoint (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.activities
Interface ITriggerPoint

public interface ITriggerPoint

A trigger point represents a place within the Workbench that has the potential to enable activities. Instances of this class may be obtained from ITriggerPointManager.getTriggerPoint(String). Instances of this interface are passed as a parameter to ITriggerPointAdvisor.allow(ITriggerPoint, IIdentifier) and may be used by the advisor to determine policy.

This interface is not intended to be extended or implemented by clients.

Since:: 3.1
See Also:: ITriggerPointAdvisor, ITriggerPointManager
Restriction:: This interface is not intended to be implemented by clients.

Field Summary

static String HINT_INTERACTIVE
          The interactive hint key.

static String HINT_PRE_UI
          A hint key for activities that are enabled based on core expressions.

Method Summary

boolean getBooleanHint ( String key)
          Return the hint with the given key defined on this trigger point as interpreted as a boolean.

String getId ()
          Return the id of this trigger point.

String getStringHint ( String key)
          Return the hint with the given key defined on this trigger point.

Field Detail

HINT_INTERACTIVE

static final 
String HINT_INTERACTIVE

The interactive hint key. Value "interactive".

See Also:: Constant Field Values

HINT_PRE_UI

static final 
String HINT_PRE_UI

A hint key for activities that are enabled based on core expressions.

Since:: 3.4
See Also:: Constant Field Values

Method Detail

getId


String getId()

Return the id of this trigger point.

Returns:: the id

getStringHint


String getStringHint(
String key)

Return the hint with the given key defined on this trigger point.

Parameters:: key - the hint key
Returns:: the hint

getBooleanHint

boolean getBooleanHint(
String key)

Return the hint with the given key defined on this trigger point as interpreted as a boolean.

Parameters:: key - the hint key
Returns:: the hint
See Also:: Boolean.valueOf(java.lang.String)