Preference Transfer

Identifier:
org.eclipse.ui.preferenceTransfer

Since:
3.1

Description:
The workbench provides support for maintaining preferences. The purpose of this extension point is to allow plug-ins to add specific support for saving and loading of specific groups of preferences. Typically this is used for operations such as Import and Export.

Configuration Markup:

<!ELEMENT extension (transfer* , (settingsTransfer*))>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT transfer (mapping+ , description?)>

<!ATTLIST transfer

id   CDATA #REQUIRED

name CDATA #REQUIRED

icon CDATA #IMPLIED>

A transfer is an element used for specifying a group of preferences that can be exported together.



<!ELEMENT description (#PCDATA)>

An optional subelement whose body should represent a short description of the transfer engine functionality.



<!ELEMENT mapping (entry*)>

<!ATTLIST mapping

scope CDATA #REQUIRED>

a subelement which represents a org.eclipse.core.runtime.preferences.IPreferenceFilter. It specifies 1 or more mappings from a scope org.eclipse.core.runtime.preferences.IScope to 0 or more nodes. 0 or more keys are specified per node. The rules for export and import behaviour for a filter can be found in the specifications in org.eclipse.core.runtime.preferences.IPreferenceFilter.



<!ELEMENT entry (key*)>

<!ATTLIST entry

node CDATA #IMPLIED>

a subelement specifing the nodes and keys that are to be transferred for a given scope



<!ELEMENT key EMPTY>

<!ATTLIST key

name  CDATA #REQUIRED

match (prefix) >


<!ELEMENT settingsTransfer (description?)>

<!ATTLIST settingsTransfer

name        CDATA #REQUIRED

id          CDATA #REQUIRED

class       CDATA #REQUIRED

helpContext CDATA #IMPLIED>

A settings transfer is the definition of a transfer of internal state from one workbench to another. Added in 3.3.



Examples:

Example that export all transfers, exports all nodes for specified scopes.


   <extension
         point="org.eclipse.ui.preferenceTransfer">
       <transfer
            icon="XYZ.png"
            name="Export All Transfer Test"
            id="org.eclipse.ui.tests.all">
            <mapping scope="instance"/>
      <mapping scope="configuration"/>
            <mapping scope="project"/>
   <description>
             Export all tranfer, exports all nodes for specified scopes
      </description>
    </transfer>
   </extension>

Bare Bones Transfer only provides required info and no more.


   <extension
         point="org.eclipse.ui.preferenceTransfer">
       <transfer
            name="Bare Bones Transfer Test"
            id="org.eclipse.ui.tests.all">
            <mapping scope="instance"/>
    </transfer>
   </extension>

Example that exports many combinations of keys and nodes


   <extension
         point="org.eclipse.ui.preferenceTransfer">
       <transfer
            icon="XYZ.png"
            name="Export many preferences"
            id="org.eclipse.ui.tests.all">
            <mapping scope="instance">
                <entry node="org.eclipse.ui">
                   <key name="DOCK_PERSPECTIVE_BAR"/>
                </entry>
                <entry node="org.eclipse.ui.workbench">
                   <key name="RUN_IN_BACKGROUND"/>
                   <key name="OPEN_" match="prefix"/>
                </entry>   
                <entry node="org.eclipse.ui.ide"/>
                <entry node="org.eclipse.core.resources"/>
            </mapping>
      <mapping scope="configuration"/>
      <description>
              Export many combinations of keys and nodes
        </description>
    </transfer>
   </extension>


Copyright (c) 2005, 2009 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 http://www.eclipse.org/legal/epl-v10.html