|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IFormattingStrategy
A formatting strategy is assumed to be specialized on formatting text of a particular content type. Each formatting process calls the strategy's methods in the following sequence:
formatterStarts
format
formatterStops
This interface must be implemented by clients. Implementers should be registered with a content formatter in order get involved in the formatting process.
| Method Summary | |
|---|---|
java.lang.String |
format(java.lang.String content,
boolean isLineStart,
java.lang.String indentation,
int[] positions)
Formats the given string. |
void |
formatterStarts(java.lang.String initialIndentation)
Informs the strategy about the start of a formatting process in which it will participate. |
void |
formatterStops()
Informs the strategy that the formatting process in which it has participated has been finished. |
| Method Detail |
|---|
void formatterStarts(java.lang.String initialIndentation)
initialIndentation - the indent string of the first line at which the
overall formatting process starts.
java.lang.String format(java.lang.String content,
boolean isLineStart,
java.lang.String indentation,
int[] positions)
content - the initial string to be formattedisLineStart - indicates whether the beginning of content is a line start in its documentindentation - the indentation string to be usedpositions - the character positions to be updated
void formatterStops()
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.