public interface IContentFormatter
The content formatter is assumed to determine the partitioning of the document range to be formatted. For each partition, the formatter determines based on the partition's content type the formatting strategy to be used. Before the first strategy is activated all strategies are informed about the start of the formatting process. After that, the formatting strategies are activated in the sequence defined by the partitioning of the document range to be formatted. It is assumed that a strategy must be finished before the next strategy can be activated. After the last strategy has been finished, all strategies are informed about the termination of the formatting process.
The interface can be implemented by clients. By default, clients use ContentFormatter
or MultiPassContentFormatter
as the standard implementers of this interface.
IDocument
,
IFormattingStrategy
Modifier and Type | Method and Description |
---|---|
void |
format(IDocument document,
IRegion region)
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.
|
IFormattingStrategy |
getFormattingStrategy(String contentType)
Returns the formatting strategy registered for the given content type.
|
void format(IDocument document, IRegion region)
document
- the document to be formattedregion
- the region within the document to be formattedIFormattingStrategy getFormattingStrategy(String contentType)
contentType
- the content type for which to look up the formatting strategynull
if there is no such strategy
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.