Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Eclipse Plug-in Developer Guide
Previous Page Home Next Page

Intro Part Configuration Extension

Identifier:
org.eclipse.ui.intro.configExtension

Since:
3.0

Description:

This extension point is used to extend an existing intro configuration by providing more content, additional StandbyContentParts or additional IntroUrl actions.

Since 3.2, this extension point is also used to contribute a presentation theme that can be used by welcome implementations to separate presentation and content.

Configuration Markup:

<!ELEMENT extension ( configExtension | standbyContentPart | action | theme)*>

<!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 configExtension EMPTY>

<!ATTLIST configExtension

configId IDREF #REQUIRED

content  CDATA #REQUIRED

>

Defines an extension to an intro configuration. Any page or group in an intro part configuration can be extended, if it has declared extensability by defining anchors.


  • configId - the id of an intro contribution that will be extended
  • content - an intro content file. The content file is an XML file that contains the specifics of the intro ( intro content file format specification). The content file is parsed at run time by the intro framework. Based on the settings in this file, a certain number of pages, groups, and links are shown to the user when the intro is opened.

<!ELEMENT standbyContentPart EMPTY>

<!ATTLIST standbyContentPart

id       CDATA #REQUIRED

pluginId CDATA #REQUIRED

class    CDATA #REQUIRED

>

standbyContentPart registration. Once registered, standby parts can be launched through an introURL action of the following format:

 
https://org.eclipse.ui.intro/showStandby?partId=&lt;id of standbyContentPart&gt;


  • id - a unique id that identifies this standbyContentPart.
  • pluginId - the name of the plugin that holds the class defined in the "class" attribute.
  • class - the fully qualified class name of the class that implements org.eclipse.ui.intro.config.IStandbyContentPart to handle displaying alternative standby content, such as a cheat sheet.

<!ELEMENT action EMPTY>

<!ATTLIST action

name     CDATA #REQUIRED

replaces CDATA #REQUIRED

>

custom Intro URL action registration. This can be used to create new Intro URL actions or a shortCut to predefined actions.


  • name - a unique name that identifies this action.
  • replaces - the macro which replaces the action name in the Intro URL.

<!ELEMENT theme ( property*)>

<!ATTLIST theme

id           CDATA #REQUIRED

name         CDATA #REQUIRED

path         CDATA #REQUIRED

default      (true | false) "false"

previewImage CDATA #IMPLIED

scalable     (true | false) "false"

>

  • id - a unique identifier of the intro theme
  • name - a translatable name of the intro theme that will be rendered in the UI
  • path - a plug-in-relative path to the folder where the style sheets and associated graphics reside.
  • default - an optional flag that indicates if this theme is the default. Default theme will be used if no theme is explicitly selected.
  • previewImage - an optional image of 4x3 ratio that will be used to preview this theme in the UI. Recommended size is 160x120.
  • scalable - Scalable themes use only relative fonts. When a scalable theme is used toolbar items will be created to enlarge or reduce the font size by setting an absolute size for a containing element.

<!ELEMENT property EMPTY>

<!ATTLIST property

name  CDATA #REQUIRED

value CDATA #REQUIRED

>

an optional theme property that can be used by intro configurers to further customize intro presentation.


  • name - unique name of the property
  • value - value of the property

Examples:
Here is an example implementation of this extension point:


<extension point=
"org.eclipse.ui.intro.configExtension"
>
    <configExtension
         configId=
"com.org.xyz.introConfig"
 
         content=
"extensionContent.xml"
/>  

    <standbyContentPart
         id=
"com.org.xyz.myStandbyPart"

         class=
"com.org.xyz.internal.MyStandbyContent"

         pluginId=
"com.org.xyz"
/>

    <action
         name=
"shortcutAction"

         replaces=
"https://org.eclipse.ui.intro/showStandby?partId=com.org.xyz.myStandbyPart"
/>

    <action
         name=
"customAction"

         replaces=
"runAction?pluginId=com.org.xyz&amp;class=com.org.xyz.CustomAction&amp;param1=value1"
/>

    <theme
         id=
"com.example.intro.flowers"

         name=
"A Nice Flowers Welcome"

         path=
"$nl$/themes/flowers"

         previewImage=
"$nl$/themes/flowers/preview.png"
>
    </theme>
</extension>

Supplied Implementation:
There are three supplied implementations:
  • org.eclipse.jdt, makes use of configExtension
  • org.eclipse.pde, makes use of configExtension
  • org.eclipse.platform, makes use of standbyContentPart


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


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire