public abstract class IntroConfigurer extends Object
CustomizableIntroPart
.
Since it is possible for multiple products to use the same intro configuration, this class allows
them to customize some aspects of the intro content so that it looks different for different
products even though they all share the same intro implementation and content.Modifier and Type | Field and Description |
---|---|
protected IIntroSite |
site |
static String |
TB_ADDITIONS
The identifier of the named group where the configurer can contribute local tool bar actions.
|
protected Map |
themeProperties |
Constructor and Description |
---|
IntroConfigurer() |
Modifier and Type | Method and Description |
---|---|
abstract IntroElement[] |
getGroupChildren(String pageId,
String groupId)
Returns the children of computed groups.
|
IntroElement[] |
getLaunchBarShortcuts()
Returns an array of elements that will be used to build launch bar short cut links.
|
String |
getMixinStyle(String pageId,
String extensionId)
Returns the style value that will be mixed in with the original style of the extension.
|
protected String |
getThemeProperty(String name)
Returns the value of the theme property with a given name.
|
abstract String |
getVariable(String variableName)
Returns the value of the variable defined by the configurer.
|
void |
init(IIntroSite site,
Map themeProperties)
Provides the opportunity for the configurer to contribute to the action bars and to fetch
presentation theme properties.
|
abstract String |
resolvePath(String extensionId,
String path)
Resolves an incomplete path in the form "page_id/@" where page_id represents the identifier
of the target page.
|
public static final String TB_ADDITIONS
init(IIntroSite, Map)
,
Constant Field Valuesprotected Map themeProperties
protected IIntroSite site
public void init(IIntroSite site, Map themeProperties)
site
- the intro part's sitethemeProperties
- properties of the current theme that can be used by the configurer, or
null
if no theme is currently active or the active theme has no
properties.protected String getThemeProperty(String name)
name
- the theme property namenull
if property is not found, the theme
does not have properties or no theme is currently active.public abstract String getVariable(String variableName)
variableName
- the name of the substitution variablenull
if the variable
cannot be resolved.public abstract IntroElement[] getGroupChildren(String pageId, String groupId)
pageId
- the identifier of the page in which this group appearsgroupId
- the identifier of the group group within the pagepublic IntroElement[] getLaunchBarShortcuts()
public abstract String resolvePath(String extensionId, String path)
extensionId
- the id specified for the config extensionpath
- the incomplete path specified for the config extensionnull
if the path cannot be resolved or the extension should be hidden.public String getMixinStyle(String pageId, String extensionId)
pageId
- the identifier of the target page that this extension is contributed intoextensionId
- the identifier of the extension to provide the mixin style for.null
if no mixin
style is found for this extension.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.