Package org.eclipse.ui.internal

Class ProductProperties

java.lang.Object
org.eclipse.ui.internal.BrandingProperties
org.eclipse.ui.internal.ProductProperties
All Implemented Interfaces:
IProductConstants
public class ProductProperties extends BrandingProperties implements IProductConstants
A class that converts the strings returned by org.eclipse.core.runtime.IProduct.getProperty to the appropriate class. This implementation is tightly bound to the properties provided in IProductConstants. Clients adding their own properties could choose to subclass this.
Since:
3.0
See Also:

  • Constructor Details

    • ProductProperties

      public ProductProperties(IProduct product)
      This instance will return properties from the given product. The properties are retrieved in a lazy fashion and cached for later retrieval.
      Parameters:
      product - must not be null

  • Method Details

    • getAppName

      public String getAppName()
      The application name, used to initialize the SWT Display. This value is distinct from the string displayed in the application title bar.

      E.g., On motif, this can be used to set the name used for resource lookup.

      See Also:

    • getAboutText

      public String getAboutText()
      The text to show in an "about" dialog for this product. Products designed to run "headless" typically would not have such text.

    • getAboutImage

      public ImageDescriptor getAboutImage()
      An image which can be shown in an "about" dialog for this product. Products designed to run "headless" typically would not have such an image.

      A full-sized product image (no larger than 500x330 pixels) is shown without the "aboutText" blurb. A half-sized product image (no larger than 250x330 pixels) is shown with the "aboutText" blurb beside it.

    • getWindowImages

      public ImageDescriptor[] getWindowImages()
      An array of one or more images to be used for this product. The expectation is that the array will contain the same image rendered at different sizes (16x16 and 32x32). Products designed to run "headless" typically would not have such images.

      If this property is given, then it supercedes WINDOW_IMAGE.

    • getWelcomePageUrl

      public URL getWelcomePageUrl()
      Location of the product's welcome page (special XML-based format), either a fully qualified valid URL or a path relative to the product's defining bundle. Products designed to run "headless" typically would not have such a page. Use of this property is discouraged in 3.0, the new org.eclipse.ui.intro extension point should be used instead.

    • getProductName

      public String getProductName()
      Returns the product name or null. This is shown in the window title and the About action.

    • getProductId

      public String getProductId()
      Returns the id for the product or null if none.

    • getAppName

      public static String getAppName(IProduct product)
      The application name, used to initialize the SWT Display. This value is distinct from the string displayed in the application title bar.

      E.g., On motif, this can be used to set the name used for resource lookup.

      The returned value will have {n} values substituted based on the current product's mappings regardless of the given product argument.

      See Also:

    • getAboutText

      public static String getAboutText(IProduct product)
      The text to show in an "about" dialog for this product. Products designed to run "headless" typically would not have such text.

      The returned value will have {n} values substituted based on the current product's mappings regardless of the given product argument.

    • getAboutImage

      public static ImageDescriptor getAboutImage(IProduct product)
      An image which can be shown in an "about" dialog for this product. Products designed to run "headless" typically would not have such an image.

      A full-sized product image (no larger than 500x330 pixels) is shown without the "aboutText" blurb. A half-sized product image (no larger than 250x330 pixels) is shown with the "aboutText" blurb beside it.

    • getWindowImages

      public static ImageDescriptor[] getWindowImages(IProduct product)
      An array of one or more images to be used for this product. The expectation is that the array will contain the same image rendered at different sizes (16x16 and 32x32). Products designed to run "headless" typically would not have such images.

      If this property is given, then it supercedes WINDOW_IMAGE.

    • getWelcomePageUrl

      public static URL getWelcomePageUrl(IProduct product)
      Location of the product's welcome page (special XML-based format), either a fully qualified valid URL or a path relative to the product's defining bundle. Products designed to run "headless" typically would not have such a page. Use of this property is discouraged in 3.0, the new org.eclipse.ui.intro extension point should be used instead.

    • getProductName

      public static String getProductName(IProduct product)
      Returns the product name or null. This is shown in the window title and the About action.

    • getProductId

      public static String getProductId(IProduct product)
      Returns the id for the product.