Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

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:
IFormattingStrategyExtension

Method Summary
 void dispose ()
          Dispose of the formatting context.
  String[] getPreferenceKeys ()
          Returns the preference keys used for the retrieval of formatting preferences.
  Object getProperty ( Object key)
          Retrieves the property key from the formatting context
 boolean isBooleanPreference ( String key)
          Is this preference key for a boolean preference?
 boolean isDoublePreference ( String key)
          Is this preference key for a double preference?
 boolean isFloatPreference ( String key)
          Is this preference key for a float preference?
 boolean isIntegerPreference ( String key)
          Is this preference key for an integer preference?
 boolean isLongPreference ( String key)
          Is this preference key for a long preference?
 boolean isStringPreference ( String key)
          Is this preference key for a string preference?
 void mapToStore ( Map map, IPreferenceStore store)
          Stores the preferences from a map to a preference store.
 void setProperty ( Object key, Object property)
          Stores the property key in the formatting context.
 void storeToMap ( IPreferenceStore store, Map map, boolean useDefault)
          Retrieves the preferences from a preference store in a map.
 

Method Detail

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

Object getProperty(
Object key)
Retrieves the property key from the formatting context

Parameters:
key - the key of the property to store in the context
Returns:
the property key if available, null otherwise

isBooleanPreference

boolean isBooleanPreference(
String key)
Is this preference key for a boolean preference?

Parameters:
key - the preference key to query its type
Returns:
true iff this key is for a boolean preference, false otherwise.

isDoublePreference

boolean isDoublePreference(
String key)
Is this preference key for a double preference?

Parameters:
key - the preference key to query its type
Returns:
true iff this key is for a double preference, false otherwise.

isFloatPreference

boolean isFloatPreference(
String key)
Is this preference key for a float preference?

Parameters:
key - The preference key to query its type
Returns:
true iff this key is for a float preference, false otherwise.

isIntegerPreference

boolean isIntegerPreference(
String key)
Is this preference key for an integer preference?

Parameters:
key - The preference key to query its type
Returns:
true iff this key is for an integer preference, false otherwise.

isLongPreference

boolean isLongPreference(
String key)
Is this preference key for a long preference?

Parameters:
key - The preference key to query its type
Returns:
true iff this key is for a long preference, false otherwise.

isStringPreference

boolean isStringPreference(
String key)
Is this preference key for a string preference?

Parameters:
key - The preference key to query its type
Returns:
true iff this key is for a string preference, false otherwise.

mapToStore

void mapToStore(
Map map,
                
IPreferenceStore store)
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 from
store - Preference store to store the preferences in

setProperty

void setProperty(
Object key,
                 
Object property)
Stores the property key in the formatting context.

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

void storeToMap(
IPreferenceStore store,
                
Map map,
                boolean useDefault)
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 from
map - Map to store the preferences in
useDefault - true if the default preferences should be used, false otherwise

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire