Jump to: navigation, search

Difference between revisions of "FAQ How do I launch the preference page that belongs to my plug-in?"

m
m
Line 1: Line 1:
Sometimes, you want to allow the user to edit preferences for your
+
Sometimes, you want to allow the user to edit preferences for your plug-in quickly, without manually opening the Preference dialog via '''Window &gt; Preferences''' and locating the page for your plug-in. You can do this by launching the Preference dialog yourself with a customized <tt>PreferenceManager</tt>, a class responsible for building the tree of preference nodes available on the left-hand side of the Preference dialog.   
plug-in quickly, without manually opening the Preference
+
dialog via '''Window &gt; Preferences''' and locating the page
+
for your plug-in. You can do this by launching the Preference dialog
+
yourself with a customized <tt>PreferenceManager</tt>, a class
+
responsible for building the tree of preference nodes available on the
+
left-hand side of the Preference dialog.   
+
  
For each preference page you want to display, create a <tt>PreferenceNode</tt> instance  
+
For each preference page you want to display, create a <tt>PreferenceNode</tt> instance that contains a reference to your page and some unique page ID. Pages are then added to a preference manager.  If you want to create a hierarchy of pages, use the <tt>PreferenceManager</tt> method <tt>addTo</tt>, where the path is a period-delimited series of page IDs above the page being added. Finally, create an instance of <tt>PreferenceDialog</tt>, passing in the preference manager you have created.  Here is sample code for opening the Preference dialog on a single preference page called <tt>MyPreferencePage</tt>:
that contains a reference to your page and some unique page ID.
+
Pages are then added to a preference manager.  If you want to
+
create a hierarchy of pages, use the <tt>PreferenceManager</tt>
+
method <tt>addTo</tt>, where the path is a period-delimited
+
series of page IDs above the page being added. Finally, create
+
an instance of <tt>PreferenceDialog</tt>, passing in the preference
+
manager you have created.  Here is sample code for opening the
+
Preference dialog on a single preference page called <tt>MyPreferencePage</tt>:
+
  
<pre>
+
<source lang="java">
  IPreferencePage page = new MyPreferencePage();
+
IPreferencePage page = new MyPreferencePage();
  PreferenceManager mgr = new PreferenceManager();
+
PreferenceManager mgr = new PreferenceManager();
  IPreferenceNode node = new PreferenceNode("1", page);
+
IPreferenceNode node = new PreferenceNode("1", page);
  mgr.addToRoot(node);
+
addToRoot(node);
  PreferenceDialog dialog = new PreferenceDialog(shell, mgr);
+
PreferenceDialog dialog = new PreferenceDialog(shell, mgr);
  dialog.create();
+
dialog.create();
  dialog.setMessage(page.getTitle());
+
dialog.setMessage(page.getTitle());
  dialog.open();
+
dialog.open();
</pre>
+
</source>
  
 
== See Also: ==
 
== See Also: ==
*[[FAQ_How_do_I_create_my_own_preference_page?]]
+
*[[FAQ How do I create my own preference page?]]
  
 
<hr><font size=-2>This FAQ was originally published in [http://www.eclipsefaq.org Official Eclipse 3.0 FAQs]. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1.0].</font>
 
<hr><font size=-2>This FAQ was originally published in [http://www.eclipsefaq.org Official Eclipse 3.0 FAQs]. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1.0].</font>

Revision as of 08:18, 13 October 2008

Sometimes, you want to allow the user to edit preferences for your plug-in quickly, without manually opening the Preference dialog via Window > Preferences and locating the page for your plug-in. You can do this by launching the Preference dialog yourself with a customized PreferenceManager, a class responsible for building the tree of preference nodes available on the left-hand side of the Preference dialog.

For each preference page you want to display, create a PreferenceNode instance that contains a reference to your page and some unique page ID. Pages are then added to a preference manager. If you want to create a hierarchy of pages, use the PreferenceManager method addTo, where the path is a period-delimited series of page IDs above the page being added. Finally, create an instance of PreferenceDialog, passing in the preference manager you have created. Here is sample code for opening the Preference dialog on a single preference page called MyPreferencePage:

IPreferencePage page = new MyPreferencePage();
PreferenceManager mgr = new PreferenceManager();
IPreferenceNode node = new PreferenceNode("1", page);
addToRoot(node);
PreferenceDialog dialog = new PreferenceDialog(shell, mgr);
dialog.create();
dialog.setMessage(page.getTitle());
dialog.open();

See Also:


This FAQ was originally published in Official Eclipse 3.0 FAQs. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the Eclipse Public License v1.0.