Package org.eclipse.jface.text.formatter
Interface IFormattingContext
- All Known Implementing Classes:
FormattingContext
public interface IFormattingContext
Formatting context used in formatting strategies implementing interface
IFormattingStrategyExtension.- Since:
- 3.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoiddispose()Dispose of the formatting context.String[]Returns the preference keys used for the retrieval of formatting preferences.getProperty(Object key) Retrieves the propertykeyfrom the formatting contextbooleanIs this preference key for a boolean preference?booleanisDoublePreference(String key) Is this preference key for a double preference?booleanisFloatPreference(String key) Is this preference key for a float preference?booleanIs this preference key for an integer preference?booleanisLongPreference(String key) Is this preference key for a long preference?booleanisStringPreference(String key) Is this preference key for a string preference?voidmapToStore(Map<Object, Object> map, IPreferenceStore store) Stores the preferences from a map to a preference store.voidsetProperty(Object key, Object property) Stores the propertykeyin the formatting context.voidstoreToMap(IPreferenceStore store, Map<Object, Object> map, boolean useDefault) Retrieves the preferences from a preference store in a map.
-
Method Details
-
dispose
void dispose()Dispose of the formatting context.Must be called after the formatting context has been used in a formatting process.
-
getPreferenceKeys
String[] getPreferenceKeys()Returns the preference keys used for the retrieval of formatting preferences.- Returns:
- The preference keys for formatting
-
getProperty
Retrieves the propertykeyfrom the formatting context- Parameters:
key- the key of the property to store in the context. Must be aString.- Returns:
- the property
keyif available,nullotherwise
-
isBooleanPreference
Is this preference key for a boolean preference?- Parameters:
key- the preference key to query its type- Returns:
trueiff this key is for a boolean preference,falseotherwise.
-
isDoublePreference
Is this preference key for a double preference?- Parameters:
key- the preference key to query its type- Returns:
trueiff this key is for a double preference,falseotherwise.
-
isFloatPreference
Is this preference key for a float preference?- Parameters:
key- The preference key to query its type- Returns:
trueiff this key is for a float preference,falseotherwise.
-
isIntegerPreference
Is this preference key for an integer preference?- Parameters:
key- The preference key to query its type- Returns:
trueiff this key is for an integer preference,falseotherwise.
-
isLongPreference
Is this preference key for a long preference?- Parameters:
key- The preference key to query its type- Returns:
trueiff this key is for a long preference,falseotherwise.
-
isStringPreference
Is this preference key for a string preference?- Parameters:
key- The preference key to query its type- Returns:
trueiff this key is for a string preference,falseotherwise.
-
mapToStore
Stores the preferences from a map to a preference store.Note that the preference keys returned by
getPreferenceKeys()must not be used in the preference store. Otherwise the preferences are overwritten.- Parameters:
map- Map to retrieve the preferences fromstore- Preference store to store the preferences in
-
setProperty
Stores the propertykeyin the formatting context.- Parameters:
key- Key of the property to store in the context. Must be aString.property- Property to store in the context. If already present, the new property overwrites the present one.
-
storeToMap
Retrieves the preferences from a preference store in a map.Note that the preference keys returned by
getPreferenceKeys()must not be used in the map. Otherwise the preferences are overwritten.- Parameters:
store- Preference store to retrieve the preferences frommap- Map to store the preferences inuseDefault-trueif the default preferences should be used,falseotherwise
-