public interface IContentFormatterExtension
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:
FormattingContextProperties.CONTEXT_DOCUMENT
.
This is equivalent to setting FormattingContextProperties.CONTEXT_REGION
with a region spanning
the whole document.FormattingContextProperties.CONTEXT_REGION
.
Note that the content formatter automatically aligns the region to a block selected region,
and if the region spans multiple partitions, it also completes eventual partitions covered only
partially by the region.FormattingContextProperties.CONTEXT_PREFERENCES
.
Note that in context based mode the content formatter is fully reentrant, but not thread-safe.
IFormattingContext
,
FormattingContextProperties
Modifier and Type | Method and Description |
---|---|
void |
format(IDocument document,
IFormattingContext context)
Formats the given region of the specified document.
|
void format(IDocument document, IFormattingContext context)
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:
document
- the document to be formattedcontext
- the formatting context to pass to the formatting strategies. This argument
must not be null
.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.