com.borland.primetime.insight
Class InsightFactory.InsightFeature

java.lang.Object
  |
  +--com.borland.primetime.insight.InsightFactory.InsightFeature

Enclosing class:

InsightFactory

public static class InsightFactory.InsightFeature

extends java.lang.Object

Represents a CodeInsight feature. E.g. the Java implementation of CodeInsight will have MemberInsight, ParameterInsight and ClassInsight. Each feature will be associated with a keystroke.

Constructor Summary

InsightFactory.InsightFeature(int featureId, java.lang.String featureName, java.lang.String featureDisplayName, java.lang.String shortDescription, java.lang.String helpUrl)
Constructs a feature with the given properties.

Method Summary

java.lang.String	getFeatureDisplayName() The locale-dependent display name of the feature.
int	getFeatureId() The numeric id associated with this feature.
java.lang.String	getFeatureName() The programmatic name of this feature.
java.lang.String	getHelpUrl() An URL that provides help for this feature.
java.lang.String	getShortDescription() A short description of this feature.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InsightFactory.InsightFeature

public InsightFactory.InsightFeature(int featureId,
                                     java.lang.String featureName,
                                     java.lang.String featureDisplayName,
                                     java.lang.String shortDescription,
                                     java.lang.String helpUrl)

Constructs a feature with the given properties.

Parameters:

featureName - The programmatic name of the feature (not localizable)

featureDisplayName - The localizable name of the feature.

featureId - The programmatic numeric id of the feature.

shortDescription - A short, localizable description of the feature.

helpUrl - URL to the help page for this feature.

Method Detail

getFeatureName

public java.lang.String getFeatureName()

The programmatic name of this feature. This is the same regardless of the locale.

Returns:

The name of the feature.

getFeatureDisplayName

public java.lang.String getFeatureDisplayName()

The locale-dependent display name of the feature.

Returns:

The locale-dependent display name of the feature.

getFeatureId

public int getFeatureId()

The numeric id associated with this feature.

Returns:

The numeric id associated with this feature.

getShortDescription

public java.lang.String getShortDescription()

A short description of this feature. This is locale dependent.

Returns:

The locale-dependent short description for this feature.

getHelpUrl

public java.lang.String getHelpUrl()

An URL that provides help for this feature.

Returns:

An URL that provides help for this feature.