|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Products are the Eclipse unit of branding. From the runtime point of view they have a name, id and description and identify the Eclipse application to run.
Since the bulk of the branding related information is
specific to the UI, products also carry an arbitrary set of properties. The valid set of
key-value pairs and their interpretation defined by the UI of the target environment.
For example, in the standard Eclipse UI, org.eclipse.ui.branding.IProductConstants
the properties of interest to the UI. Other clients may specify additional properties.
Products can be defined directly using extensions to the org.eclipse.core.runtime.products
extension point or by using facilities provided by IProductProvider implementations.
For readers familiar with Eclipse 2.1 and earlier, products are roughly equivalent to primary features.
IProductProvider
,
IProductConstants
Method Summary | |
---|---|
String |
getApplication()
Returns the application associated with this product. |
Bundle |
getDefiningBundle()
Returns the bundle which is responsible for the definition of this product. |
String |
getDescription()
Returns the text description of this product |
String |
getId()
Returns the unique product id of this product. |
String |
getName()
Returns the name of this product. |
String |
getProperty(String key)
Returns the property of this product with the given key. |
Method Detail |
public String getApplication()
null
if nonepublic String getName()
null
if nonepublic String getDescription()
null
if nonepublic String getId()
public String getProperty(String key)
null
is returned if there is no such key/value pair.
key
- the name of the property to return
null
if nonepublic Bundle getDefiningBundle()
null
if none
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.