org.eclipse.ui.intro.config
Class IntroConfigurer

java.lang.Object
  org.eclipse.ui.intro.config.IntroConfigurer

public abstract class IntroConfigurer

extends Object

Classes that extend this abstract class are used to configure 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.

Since:

3.2

Constructor Summary

IntroConfigurer()

Method Summary

abstract IntroElement[]	getGroupChildren(String pageId, String groupId) Returns the children of dynamic groups.
abstract String	getVariable(String variableName) Returns the value of the variable defined by the configurer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntroConfigurer

public IntroConfigurer()

Method Detail

getVariable

public abstract String getVariable(String variableName)

Returns the value of the variable defined by the configurer. This variable can appear in XML content files in attribute names and values of elements. Whenever $variable$ is encountered in the content, it is evaluated using this class by passing 'variable' to this method and substituting the result in the content.

Parameters:

variableName - the name of the substitution variable

Returns:

the value to substitute in place of a variable or null if the variable cannot be resolved.

getGroupChildren

public abstract IntroElement[] getGroupChildren(String pageId,
                                                String groupId)

Returns the children of dynamic groups. Groups marked as dynamic will be completed at run time when the group is asked to provide children.

Parameters:

pageId - the identifier of the page in which this group appears

groupId - the identifier of the group group within the page

Returns:

an array of intro elements for this group. Each intro element should contain only legal elements and attributes according to the intro content schema. Returns an empty array for no children.