Package org.eclipse.ui.internal
Class BundleGroupProperties
java.lang.Object
org.eclipse.ui.internal.BrandingProperties
org.eclipse.ui.internal.BundleGroupProperties
- All Implemented Interfaces:
IBundleGroupConstants
A class that converts the strings returned by
org.eclipse.core.runtime.IBundleGroup.getProperty
to the
appropriate class. This implementation is tightly bound to the properties
provided in IBundleGroupConstants. Clients adding their own properties could
choose to subclass this.- Since:
- 3.0
- See Also:
-
Field Summary
Fields inherited from interface org.eclipse.ui.branding.IBundleGroupConstants
ABOUT_TEXT, BRANDING_BUNDLE_ID, BRANDING_BUNDLE_VERSION, FEATURE_IMAGE, LICENSE_HREF, TIPS_AND_TRICKS_HREF, WELCOME_PAGE, WELCOME_PERSPECTIVE
-
Constructor Summary
ConstructorDescriptionBundleGroupProperties
(IBundleGroup bundleGroup) This instance will return properties from the given bundle group. -
Method Summary
Modifier and TypeMethodDescriptionstatic String
getBrandingBundleId
(IBundleGroup bundleGroup) A Feature's branding plugin id.static String
getBrandingBundleVersion
(IBundleGroup bundleGroup) A Feature's branding plugin version.Returns the id for this bundleGroup.static String
getFeatureId
(IBundleGroup bundleGroup) Returns the id for this bundleGroup.An image which can be shown in an "about features" dialog (32x32).static ImageDescriptor
getFeatureImage
(IBundleGroup bundleGroup) An image which can be shown in an "about features" dialog (32x32).The URL to an image which can be shown in an "about features" dialog (32x32).static URL
getFeatureImageUrl
(IBundleGroup bundleGroup) The URL to an image which can be shown in an "about features" dialog (32x32).Returns a label for the feature plugn, ornull
.static String
getFeatureLabel
(IBundleGroup bundleGroup) Returns a label for the feature plugn, ornull
.Returns the feature version id.static String
getFeatureVersion
(IBundleGroup bundleGroup) Returns the feature version id.A URL for the feature's license page.static URL
getLicenseUrl
(IBundleGroup bundleGroup) A URL for the feature's license page.Returns the provider name.static String
getProviderName
(IBundleGroup bundleGroup) Returns the provider name.A help reference for the feature's tips and tricks page (optional).static String
getTipsAndTricksHref
(IBundleGroup bundleGroup) A help reference for the feature's tips and tricks page (optional).A URL for the feature's welcome page (special XML-based format) ($nl$/ prefix to permit locale-specific translations of entire file).static URL
getWelcomePageUrl
(IBundleGroup bundleGroup) A URL for the feature's welcome page (special XML-based format) ($nl$/ prefix to permit locale-specific translations of entire file).The id of a perspective in which to show the welcome page (optional).static String
getWelcomePerspective
(IBundleGroup bundleGroup) The id of a perspective in which to show the welcome page (optional).Methods inherited from class org.eclipse.ui.internal.BrandingProperties
getImage, getImages, getUrl, getURLs
-
Constructor Details
-
BundleGroupProperties
This instance will return properties from the given bundle group. The properties are retrieved in a lazy fashion and cached for later retrieval.- Parameters:
bundleGroup
- must not be null
-
-
Method Details
-
getFeatureImage
An image which can be shown in an "about features" dialog (32x32). -
getFeatureImageUrl
The URL to an image which can be shown in an "about features" dialog (32x32). -
getTipsAndTricksHref
A help reference for the feature's tips and tricks page (optional). -
getWelcomePageUrl
A URL for the feature's welcome page (special XML-based format) ($nl$/ prefix to permit locale-specific translations of entire file). Products designed to run "headless" typically would not have such a page. -
getWelcomePerspective
The id of a perspective in which to show the welcome page (optional). -
getLicenseUrl
A URL for the feature's license page. -
getFeatureLabel
Returns a label for the feature plugn, ornull
. -
getFeatureId
Returns the id for this bundleGroup. -
getProviderName
Returns the provider name. -
getFeatureVersion
Returns the feature version id. -
getBrandingBundleId
- Returns:
- the branding plugin id, or
null
-
getBrandingBundleVersion
- Returns:
- the branding plugin version, or
null
-
getFeatureImage
An image which can be shown in an "about features" dialog (32x32). -
getFeatureImageUrl
The URL to an image which can be shown in an "about features" dialog (32x32). -
getTipsAndTricksHref
A help reference for the feature's tips and tricks page (optional). -
getWelcomePageUrl
A URL for the feature's welcome page (special XML-based format) ($nl$/ prefix to permit locale-specific translations of entire file). Products designed to run "headless" typically would not have such a page. -
getWelcomePerspective
The id of a perspective in which to show the welcome page (optional). -
getLicenseUrl
A URL for the feature's license page. -
getFeatureLabel
Returns a label for the feature plugn, ornull
. -
getFeatureId
Returns the id for this bundleGroup. -
getProviderName
Returns the provider name. -
getFeatureVersion
Returns the feature version id. -
getBrandingBundleId
A Feature's branding plugin id.- Returns:
- the ID or
null
if not provided.
-
getBrandingBundleVersion
A Feature's branding plugin version.- Returns:
- the version, or
null
if not provided.
-