Intro Part

Identifier:

org.eclipse.ui.intro

Since:

3.0

Description:

This extension point is used to register implementations of special workbench parts, called intro parts, that are responsible for introducing a product to new users. An intro part is typically shown the first time a product is started up. Rules for associating an intro part implementation with particular products are also contributed via this extension point.

The life cycle is as follows:

• The intro area is created on workbench start up. As with editor and view areas, this area is managed by an intro site (implementing org.eclipse.ui.intro.IIntroSite).

• The id of the current product (Platform.getProduct()) is used to choose the relevant intro part implementation.

• The intro part class (implementing org.eclipse.ui.intro.IIntroPart) is created and initialized with the intro site.

• While the intro part is showing to the user, it can transition back and forth between full and standby mode (either programmatically or explicitly by the user).

• Eventually the intro part is closed (either programmatically or explicitly by the user). The current perspective takes over the entire workbench window area.

Configuration Markup:

<!ELEMENT extension (intro* , introProductBinding*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

• point - a fully qualified identifier of the target extension point

• id - an optional identifier of the extension instance

• name - an optional name of the extension instance

<!ELEMENT intro EMPTY>

<!ATTLIST intro

id    CDATA #REQUIRED

icon  CDATA #IMPLIED

class CDATA #REQUIRED>

Specifies an introduction. An introduction is a product-specific presentation shown to first-time users on product start up.

• id - a unique identifier for this introduction

• icon - a plug-in-relative file name of the icon that will be associated with this introduction

• class - a fully qualified name of the class implementing the org.eclipse.ui.intro.IIntroPart interface. A common practice is to subclass org.eclipse.ui.part.intro.IntroPart in order to inherit the default functionality. This class implements the introduction.

<!ELEMENT introProductBinding EMPTY>

<!ATTLIST introProductBinding

productId CDATA #REQUIRED

introId   CDATA #REQUIRED>

Specifies a binding between a product and an introduction. These bindings determine which introduction is appropriate for the current product (as defined by org.eclipse.core.runtime.Platform.getProduct()).

• productId - unique id of a product

• introId - unique id of an introduction

Examples:

The following is an example of an intro part extension that contributes an particular introduction and associates it with a particular product:

  
<extension point=
"org.eclipse.ui.intro"
>
     
<intro
        id=
"com.example.xyz.intro.custom"

        class=
"com.example.xyz.intro.IntroPart"
/>
     
<introProductBinding
        productId=
"com.example.xyz.Product"

        introId=
"com.example.xyz.intro.custom"
/>
  
</extension>

API Information:

The value of the class attribute must be the fully qualified name of a class that implements theorg.eclipse.ui.intro.IIntroPart interface by subclassing org.eclipse.ui.part.intro.IntroPart.

Supplied Implementation:

There are no default implementations of the initial user experience. Each Eclipse-based product is responsible for providing one that is closely matched to its branding and function.

Copyright (c) 2004 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html