org.eclipse.ui.dialogs
Class PreferencesUtil
java.lang.Object
org.eclipse.ui.dialogs.PreferencesUtil
public final class PreferencesUtil
- extends java.lang.Object
The PreferencesUtil class is the class that opens a properties or preference
dialog on a set of ids.
- Since:
- 3.1
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PreferencesUtil
public PreferencesUtil()
createPreferenceDialogOn
public static final PreferenceDialog createPreferenceDialogOn(Shell shell,
java.lang.String preferencePageId,
java.lang.String[] displayedIds,
java.lang.Object data)
- Creates a workbench preference dialog and selects particular preference page.
If there is already a preference dialog open this dialog is used and its
selection is set to the page with id preferencePageId.
Show the other pages as filtered results using whatever filtering
criteria the search uses. It is the responsibility of the caller to then
call
open()
. The call to open()
will not
return until the dialog closes, so this is the last chance to manipulate
the dialog.
- Parameters:
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.
- Returns:
- a preference dialog.
- Since:
- 3.1
- See Also:
PreferenceDialog.PreferenceDialog(Shell, PreferenceManager)
createPropertyDialogOn
public static final PreferenceDialog createPropertyDialogOn(Shell shell,
IAdaptable element,
java.lang.String propertyPageId,
java.lang.String[] displayedIds,
java.lang.Object data)
- Creates a workbench preference dialog to a particular preference page.
Show the other pages as filtered results using whatever filtering
criteria the search uses. It is the responsibility of the caller to then
call
open()
. The call to open()
will not
return until the dialog closes, so this is the last chance to manipulate
the dialog.
- Parameters:
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.
- Returns:
- A preference dialog showing properties for the selection or
null
if it could not be created. - Since:
- 3.1