| java.lang.Object
 org.eclipse.ui.internal.BrandingProperties
org.eclipse.ui.internal.ProductProperties
| ProductProperties | | public class ProductProperties extends BrandingProperties implements IProductConstants(Code) | | 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.
See Also: org.eclipse.ui.branding.IProductConstants
since:
3.0 |
| Constructor Summary | |
| public | ProductProperties(IProduct product)
This instance will return properties from the given product. |
| Method Summary | |
| public ImageDescriptor | getAboutImage()
An image which can be shown in an "about" dialog for this
product. | | public static ImageDescriptor | getAboutImage(IProduct product)
An image which can be shown in an "about" dialog for this
product. | | public String | getAboutText()
The text to show in an "about" dialog for this product. | | public static String | getAboutText(IProduct product)
The text to show in an "about" dialog for this product. | | public String | getAppName()
The application name, used to initialize the SWT Display. | | public static String | getAppName(IProduct product)
The application name, used to initialize the SWT Display. | | public String | getProductId()
Returns the id for the product or null if none. | | public static String | getProductId(IProduct product)
Returns the id for the product. | | public String | getProductName()
Returns the product name or null. | | public static String | getProductName(IProduct product)
Returns the product name or null. | | 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. | | 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. | | public ImageDescriptor[] | getWindowImages()
An array of one or more images to be used for this product. | | public static ImageDescriptor[] | getWindowImages(IProduct product)
An array of one or more images to be used for this product. |
| ProductProperties | | public ProductProperties(IProduct product)(Code) | | 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 |
| getAboutImage | | public ImageDescriptor getAboutImage()(Code) | | 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.
|
| getAboutImage | | public static ImageDescriptor getAboutImage(IProduct product)(Code) | | 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.
|
| getAboutText | | public String getAboutText()(Code) | | The text to show in an "about" dialog for this product.
Products designed to run "headless" typically would not
have such text.
|
| getAboutText | | public static String getAboutText(IProduct product)(Code) | | 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.
|
| getAppName | | public String getAppName()(Code) | | 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: org.eclipse.swt.widgets.Display.setAppName |
| getAppName | | public static String getAppName(IProduct product)(Code) | | 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: org.eclipse.swt.widgets.Display.setAppName |
| getProductId | | public String getProductId()(Code) | | Returns the id for the product or null if none.
|
| getProductId | | public static String getProductId(IProduct product)(Code) | | Returns the id for the product.
|
| getProductName | | public String getProductName()(Code) | | Returns the product name or null.
This is shown in the window title and the About action.
|
| getProductName | | public static String getProductName(IProduct product)(Code) | | Returns the product name or null.
This is shown in the window title and the About action.
|
| getWelcomePageUrl | | public URL getWelcomePageUrl()(Code) | | 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.
|
| getWelcomePageUrl | | public static URL getWelcomePageUrl(IProduct product)(Code) | | 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.
|
| getWindowImages | | public ImageDescriptor[] getWindowImages()(Code) | | 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.
|
| getWindowImages | | public static ImageDescriptor[] getWindowImages(IProduct product)(Code) | | 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.
|
|
|