Intro Part

Identifier:

Since:

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 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

contentDetector CDATA #IMPLIED

label           CDATA #IMPLIED>

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.
• contentDetector - a fully qualified name of a class extending org.eclipse.ui.intro.IntroContentDetector. This optional class is used to detect newly added introduction content. If new content is available, the view showing the introduction will be opened again.
• label - an string label for this introduction that will be used in the construction of the open action as well as the part label Since 3.2

<!ELEMENT introProductBinding EMPTY>

<!ATTLIST introProductBinding

productId IDREF #REQUIRED

introId   IDREF #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:

  <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:

Supplied Implementation:

Copyright (c) 2004, 2009 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0