Quicklinks Configuration

Identifier:

org.eclipse.ui.intro.quicklinks

Since:

Quicklinks first appeared in the Eclipse Platform 4.6, part of the Neon release train.

Description:

This extension point is used to configure the Quicklinks Welcome/Intro viewer component. Quicklinks are useful actions to be shown to a user in the Welcome/Intro. The Quicklinks use the Eclipse Core Commands framework (see the org.eclipse.ui.commands extension point), but supports overriding the icon and text to be used for an item. The Quicklinks is experimental component and is not yet considered API.

Configuration Markup:

<!ELEMENT extension (command | override | url)+>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT command EMPTY>

<!ATTLIST command

id IDREF #REQUIRED

label CDATA #IMPLIED

description CDATA #IMPLIED

icon CDATA #IMPLIED

importance (high|medium|low)

resolution (standby|launchbar|close|full) >

Defines a Quicklink component. One of "command" or "url" must be specified.

id - The command identifier to be invoked. The command can also be a serialized command to encode command parameters (see ParameterizedCommand#serialize() for details).
label - The label to be displayed. If unspecified, the command name is used instead.
description - A description for the quicklink. If unspecified, use the command's description.
icon - The icon to be used for the quicklink. If unspecified, the command's associated image is used instead.
importance - Define the level of importance of this item. If unspecified, defaults to "low".
resolution - What should happen to the Welcome view after executing the command. If "full" or unspecified, the Welcome/Intro part will be put into full visual mode. If "standby" (the default), the Welcome/Intro part will be put into standby mode. If "launchbar", the Welcome/Intro will be put into 'launchbar' mode in the status area. If "close" then the Welcome/Intro will be closed.

<!ELEMENT url EMPTY>

<!ATTLIST url

location CDATA #REQUIRED

label CDATA #REQUIRED

description CDATA #REQUIRED

icon CDATA #IMPLIED

importance (high|medium|low) >

Defines a URL Quicklink component. URL Quicklinks must provide a label and it is recommended to provide an icon and description

location - The URL to be invoked. The URL can either be an Intro URL or an external URL.
label - The label to be displayed. If unspecified, the command name is used instead.
description - A description for the quicklink. If unspecified, use the command's description.
icon - The icon to be used for the quicklink. If unspecified, the command's associated image is used instead.
importance - Define the level of importance of this item. If unspecified, defaults to "low".

<!ELEMENT override EMPTY>

<!ATTLIST override

command IDREF #REQUIRED

theme IDREF #REQUIRED

icon CDATA #REQUIRED>

Provide a mechanism for a theme to override the icons used to represent a command in a quicklink.

command - The command identifier as referenced in a <quicklink> element. The command can also be a serialized command to encode command parameters (see ParameterizedCommand#serialize() for details). The command may include simple '*' wildcards to match any substring. For example, org.eclipse.ui.newWizard* will match any "New" wizard definitions.
theme - The theme identifier. May be a comma-separated set of values.
icon - The icon to be used for representing this command.

Examples:

Here is an example of configuring a Quicklink:


   <extension
         point="org.eclipse.ui.intro.quicklinks">
      <!-- Reuses command definition label and icons -->
      <quicklink
            command="org.eclipse.epp.mpc.ui.command.showMarketplaceWizard"
            icon="icons/mpcdrag.png">
      </quicklink>
      
      <!-- Invoke a particular new wizard; place the Welcome/Intro in Standby mode on success -->
      <quicklink
            command="org.eclipse.ui.newWizard(newWizardId=org.eclipse.jdt.ui.wizards.JavaProjectWizard)"
            description="Create a new Java Eclipse project"
            label="Create a new Java project"
            standby="true">
      </quicklink>
      
      <!-- Allow overriding theme and icons for all newWizard-related commands -->
      <override
            command="org.eclipse.ui.newWizard*"
            icon="icons/solstice/new-project.png"
            theme="org.eclipse.ui.intro.universal.solstice">
      </override>
   </extension>

Quicklinks are shown using the Quicklinks Viewer Component in a introContent.xml definition.


 <extensionContent id="quicklinks" name="Quick Actions" path="root/extra-group2/anchor">
        <contentProvider 
         pluginId="org.eclipse.ui.intro.quicklinks"
         class="org.eclipse.ui.intro.quicklinks.QuicklinksViewer"
         id="quick-links">
        </contentProvider>
    </extensionContent>

API Information:

Quicklinks are still experimental and not yet considered API.

Supplied Implementation:

Quicklinks are still experimental and not yet considered API.

Copyright (c) 2016, 2017 Manumitting Technologies Inc 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