org.eclipse.jface.text.formatter
Class FormattingContext
java.lang.Object
org.eclipse.jface.text.formatter.FormattingContext
-
All Implemented Interfaces:
-
IFormattingContext
-
public class FormattingContext
- extends
Object
- implements
IFormattingContext
Default implementation of IFormattingContext
.
-
Since:
- 3.0
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
FormattingContext
public FormattingContext()
dispose
public void dispose()
-
Description copied from interface:
IFormattingContext
- Dispose of the formatting context.
Must be called after the formatting context has been used in a formatting process.
-
-
Specified by:
-
dispose
in interface
IFormattingContext
-
getPreferenceKeys
public
String[] getPreferenceKeys()
-
Description copied from interface:
IFormattingContext
- Returns the preference keys used for the retrieval of formatting preferences.
-
-
Specified by:
-
getPreferenceKeys
in interface
IFormattingContext
-
-
Returns:
- The preference keys for formatting
getProperty
public
Object getProperty(
Object key)
-
Description copied from interface:
IFormattingContext
- Retrieves the property
key
from the formatting context
-
-
Specified by:
-
getProperty
in interface
IFormattingContext
-
-
Parameters:
-
key
- the key of the property to store in the context
-
Returns:
- the property
key
if available, null
otherwise
isBooleanPreference
public boolean isBooleanPreference(
String key)
-
Description copied from interface:
IFormattingContext
- Is this preference key for a boolean preference?
-
-
Specified by:
-
isBooleanPreference
in interface
IFormattingContext
-
-
Parameters:
-
key
- the preference key to query its type
-
Returns:
-
true
iff this key is for a boolean preference, false
otherwise.
isDoublePreference
public boolean isDoublePreference(
String key)
-
Description copied from interface:
IFormattingContext
- Is this preference key for a double preference?
-
-
Specified by:
-
isDoublePreference
in interface
IFormattingContext
-
-
Parameters:
-
key
- the preference key to query its type
-
Returns:
-
true
iff this key is for a double preference, false
otherwise.
isFloatPreference
public boolean isFloatPreference(
String key)
-
Description copied from interface:
IFormattingContext
- Is this preference key for a float preference?
-
-
Specified by:
-
isFloatPreference
in interface
IFormattingContext
-
-
Parameters:
-
key
- The preference key to query its type
-
Returns:
-
true
iff this key is for a float preference, false
otherwise.
isIntegerPreference
public boolean isIntegerPreference(
String key)
-
Description copied from interface:
IFormattingContext
- Is this preference key for an integer preference?
-
-
Specified by:
-
isIntegerPreference
in interface
IFormattingContext
-
-
Parameters:
-
key
- The preference key to query its type
-
Returns:
-
true
iff this key is for an integer preference, false
otherwise.
isLongPreference
public boolean isLongPreference(
String key)
-
Description copied from interface:
IFormattingContext
- Is this preference key for a long preference?
-
-
Specified by:
-
isLongPreference
in interface
IFormattingContext
-
-
Parameters:
-
key
- The preference key to query its type
-
Returns:
-
true
iff this key is for a long preference, false
otherwise.
isStringPreference
public boolean isStringPreference(
String key)
-
Description copied from interface:
IFormattingContext
- Is this preference key for a string preference?
-
-
Specified by:
-
isStringPreference
in interface
IFormattingContext
-
-
Parameters:
-
key
- The preference key to query its type
-
Returns:
-
true
iff this key is for a string preference, false
otherwise.
mapToStore
public void mapToStore(
Map map,
IPreferenceStore store)
-
Description copied from interface:
IFormattingContext
- Stores the preferences from a map to a preference store.
Note that the preference keys returned by
IFormattingContext.getPreferenceKeys()
must not be used in
the preference store. Otherwise the preferences are overwritten.
-
-
Specified by:
-
mapToStore
in interface
IFormattingContext
-
-
Parameters:
-
map
- Map to retrieve the preferences from -
store
- Preference store to store the preferences in
setProperty
public void setProperty(
Object key,
Object property)
-
Description copied from interface:
IFormattingContext
- Stores the property
key
in the formatting context.
-
-
Specified by:
-
setProperty
in interface
IFormattingContext
-
-
Parameters:
-
key
- Key of the property to store in the context -
property
- Property to store in the context. If already present, the new property
overwrites the present one.
storeToMap
public void storeToMap(
IPreferenceStore store,
Map map,
boolean useDefault)
-
Description copied from interface:
IFormattingContext
- Retrieves the preferences from a preference store in a map.
Note that the preference keys returned by
IFormattingContext.getPreferenceKeys()
must not be used in
the map. Otherwise the preferences are overwritten.
-
-
Specified by:
-
storeToMap
in interface
IFormattingContext
-
-
Parameters:
-
store
- Preference store to retrieve the preferences from -
map
- Map to store the preferences in -
useDefault
- true
if the default preferences should be used,
false
otherwise
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.