Eclipse Platform
Release 3.1

org.eclipse.jface.text.formatter
Interface IContentFormatterExtension

All Known Implementing Classes:
MultiPassContentFormatter

public interface IContentFormatterExtension

Extension interface for IContentFormatter.

Updates the content formatter to be able to pass IFormattingContext context objects to IFormattingStrategyExtension objects operating in context based mode.

Clients using context based formatting call the method format(IDocument, IFormattingContext) with a properly initialized formatting context.
The formatting context must be set up according to the desired formatting mode:

Depending on the registered formatting strategies, more context information must be passed in the formatting context, like e.g. FormattingContextProperties.CONTEXT_PREFERENCES.

Note that in context based mode the content formatter is fully reentrant, but not thread-safe.

Since:
3.0
See Also:
IFormattingContext, FormattingContextProperties

Method Summary
 void format(IDocument document, IFormattingContext context)
          Formats the given region of the specified document.
 

Method Detail

format

public void format(IDocument document,
                   IFormattingContext context)
Formats the given region of the specified document.

The formatter may safely assume that it is the only subject that modifies the document at this point in time. This method is fully reentrant, but not thread-safe.

The formatting process performed by format(IDocument, IFormattingContext) happens as follows:


Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.