Eclipse RSE Development Guide
Previous Page	Home	Next Page

RSE Developer Guide Reference Extension Points Reference

New Connection Wizards

Identifier:

org.eclipse.rse.ui.newConnectionWizards

Since:

RSE 2.0

Description:

This extension point is used to register new connection creation wizard extensions. New connection creation wizards appear as choices within the "New Connection" dialog, and are used to create connections from the registered system types. New connection creation wizards can be organized in categories. Uncategorized wizards or wizards with invalid category paths will be sorted in as non-categorized root element.

Each system type must have exactly one new connection wizard associated. In case multiple new connection wizard contributions would match the same system type, the new connection wizard which matched the system type first, will be used.

One new connection wizard may be registered for multiple system types. Such wizards should implement the org.eclipse.jface.viewers.ISelectionChangedListener interface. to get notified about the currently selected system type within the new connection system type selection page.

Note: The main RSE new connection wizard is using the selectionChanged(SelectionChangedEvent) to notify the nested wizards about

system type selection changes in the RSE new connection wizard selection page and
the selected context of a view or toolbar or menu the caller of the main RSE new connection wizard is passing in.

If the caller of the main RSE new connection wizard has passed in a selected context, the structured selection given via the selectionChanged call has two elements. The first element is always the selected system type (instance of type IRSESystemType) and the second one, if present, is the selected context from the caller (instance of type ISelection).

New connection wizard may have the need of contributing different attribute values for the same attribute dependent on the current system type selection. These wizards should implement the org.eclipse.rse.ui.wizards.newconnection.IRSEDynamicNewConnectionWizard.

Configuration Markup:

<!ELEMENT extension ( newConnectionWizard* | category*)+>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED

(no description available)

<!ELEMENT newConnectionWizard EMPTY>

<!ATTLIST newConnectionWizard

id CDATA #REQUIRED

name CDATA #REQUIRED

description CDATA #IMPLIED

systemTypeIds CDATA #IMPLIED

class CDATA #REQUIRED

categoryId CDATA #IMPLIED

canFinishEarly (true | false) "false"

hasPages (true | false) "true"

id - A unique identifier.
name - A translatable name that will be used in the UI.
description - A translatable short description of the wizard.
systemTypeIds - A semicolon separated list of RSE system type id's this wizard will be registered for. RSE system type id's which have already a new connection creation wizard registered are ignored. Wildcards '*' and '?' are allowed. If empty, all registered RSE system types will be queried if accepting this new connection creation wizard by id.
class - A fully qualified name of the Java class implementing org.eclipse.jface.wizard.IWizard.
categoryId - A fully qualified valid category id previously defined by this or some other plug-in. If omitted or if the specified category id is invalid, the wizard will be added as non-categorized root element.
The default RSE wizard category id is "org.eclipse.rse.ui.wizards.newconnection.default.category".
canFinishEarly - Whether the wizard is capable of finishing without ever showing pages to the user.
hasPages - Whether the wizard provides any pages.

<!ELEMENT category EMPTY>

<!ATTLIST category

id CDATA #REQUIRED

name CDATA #REQUIRED

parentCategoryId CDATA #IMPLIED

id - A unique identifier.
name - A translatable name that will be used in the UI.
parentCategoryId - The fully qualified id of the parent category or empty if it is a root category.

Examples:

The following is an example of this extension point's usage:


  <extension point=
"org.eclipse.rse.ui.newConnectionWizards"
>
     <category id=
"org.eclipse.rse.ui.wizards.newconnection.default.category"

               name=
"%Creation.category.name"
/>
     <newConnectionWizard
         id=
"org.eclipse.rse.ui.wizards.newconnection.RSEDefaultNewConnectionWizard"

         class=
"org.eclipse.rse.ui.wizards.newconnection.RSEDefaultNewConnectionWizard"

         name=
"%DefaultRSENewConnectionWizard.name"

         canFinishEarly=
"false"

         categoryId=
"org.eclipse.rse.ui.wizards.newconnection.default.category"

         hasPages=
"true"
>
     </newConnectionWizard>
  </extension>

Supplied Implementation:

The default RSE new connection wizard as contributed from org.eclipse.rse.ui plug-in.

Copyright (c) 2006, 2007 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 Contributors: IBM Corporation - initial API and implementation Uwe Stieber (Wind River) - rework to take standard Eclipse IWizard's