|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.dialogs.PreferencesUtil
The PreferencesUtil class is the class that opens a properties or preference dialog on a set of ids.
Constructor Summary | |
---|---|
PreferencesUtil()
|
Method Summary | |
---|---|
static PreferenceDialog |
createPreferenceDialogOn(Shell shell,
String preferencePageId,
String[] displayedIds,
Object data)
Creates a workbench preference dialog and selects particular preference page. |
static PreferenceDialog |
createPropertyDialogOn(Shell shell,
IAdaptable element,
String propertyPageId,
String[] displayedIds,
Object data)
Creates a workbench preference dialog to a particular preference page. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PreferencesUtil()
Method Detail |
public static final PreferenceDialog createPreferenceDialogOn(Shell shell, String preferencePageId, String[] displayedIds, Object data)
open()
. The call to open()
will not
return until the dialog closes, so this is the last chance to manipulate
the dialog.
shell
- The Shell to parent the dialog off of if it is not
already created. May be null
in which case the active workbench window will be used
if available.preferencePageId
- The identifier of the preference page to open; may be
null
. If it is null
, then the
preference page is not selected or modified in any way.displayedIds
- The ids of the other pages to be displayed using the same
filtering criterea as search. If this is null
,
then the all preference pages are shown.data
- Data that will be passed to all of the preference pages to be
applied as specified within the page as they are created. If
the data is null
nothing will be called.
PreferenceDialog.PreferenceDialog(Shell, PreferenceManager)
public static final PreferenceDialog createPropertyDialogOn(Shell shell, IAdaptable element, String propertyPageId, String[] displayedIds, Object data)
open()
. The call to open()
will not
return until the dialog closes, so this is the last chance to manipulate
the dialog.
shell
- The shell to use to parent the dialog if required.propertyPageId
- The identifier of the preference page to open; may be
null
. If it is null
, then the
dialog is opened with no selected page.element
- IAdaptable An adaptable element to open the dialog
on.displayedIds
- The ids of the other pages to be displayed using the same
filtering criterea as search. If this is null
,
then the all preference pages are shown.data
- Data that will be passed to all of the preference pages to be
applied as specified within the page as they are created. If
the data is null
nothing will be called.
null
if it could not be created.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.