public interface IPreferenceFilter
For instance, a client is able to create a preference filter describing which preference nodes/keys should be used when exporting the "Key Bindings" preferences. When the export happens, the tree is trimmed and only the applicable preferences will be exported.
Clients may implement this interface.
Modifier and Type | Method and Description |
---|---|
Map |
getMapping(String scope)
Return a mapping which defines the nodes and keys that this filter
applies to.
|
String[] |
getScopes()
Return an array of scopes that this preference filter is applicable for.
|
String[] getScopes()
null
.
For example:
new String[] {InstanceScope.SCOPE, ConfigurationScope.SCOPE};
Map getMapping(String scope)
If the map is null
then this filter is applicable for all
nodes within the scope. The map can also be null
if
the given scope is not known to this filter.
The keys in the table are Strings and describe the node path. The values are
an optional array of PreferenceFilterEntry
objects describing the list of
applicable keys in that node. If the value is null then the whole node is
considered applicable.
key: String
(node)
value: PreferenceFilterEntry[]
or null
(preference keys)
For example:
"org.eclipse.core.resources" -> null "org.eclipse.ui" -> new PreferenceFilterEntry[] { new PreferenceFilterEntry("DEFAULT_PERSPECTIVE_LOCATION"), new PreferenceFilterEntry("SHOW_INTRO_ON_STARTUP")}
PreferenceFilterEntry
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.