Interface IFormattingStrategy

All Known Implementing Classes:
ContextBasedFormattingStrategy

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

    Modifier and Type
    Method
    Description
    format(String content, boolean isLineStart, String indentation, int[] positions)
    Formats the given string.
    void
    formatterStarts(String initialIndentation)
    Informs the strategy about the start of a formatting process in which it will participate.
    void
    Informs the strategy that the formatting process in which it has participated has been finished.
  • Method Details

    • formatterStarts

      void formatterStarts(String initialIndentation)
      Informs the strategy about the start of a formatting process in which it will participate.
      Parameters:
      initialIndentation - the indent string of the first line at which the overall formatting process starts.
    • format

      String format(String content, boolean isLineStart, String indentation, int[] positions)
      Formats the given string. During the formatting process this strategy must update the given character positions according to the changes applied to the given string.
      Parameters:
      content - the initial string to be formatted
      isLineStart - indicates whether the beginning of content is a line start in its document
      indentation - the indentation string to be used
      positions - the character positions to be updated
      Returns:
      the formatted string
    • formatterStops

      void formatterStops()
      Informs the strategy that the formatting process in which it has participated has been finished.