de.vc.jfo.rtf

## Interface ImportListener

- All Known Implementing Classes:
    ImportListenerAdapter

      public interface ImportListener

  An import listener is notified by the RTF importer on various events. Currently following events are handled:
  - A bookmark starts.
  - A bookmark ends.
  - Text is inserted.
  Please note: in future releases we'll probably extend this interface. Please use the adapater class `ImportListenerAdapter` to avoid any problems with future version.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `onBookmarkEnd(java.lang.String bookmark, DocumentContext ctx)` This method is invoked when a bookmark ends.
    `void` | `onBookmarkStart(java.lang.String bookmark, DocumentContext ctx)` This method is invoked when a bookmark starts.
    `java.lang.String` | `onInsertText(java.lang.String text)` This method is invoked when text is inserted.

- - ### Method Detail

    - #### onBookmarkStart

          void onBookmarkStart(java.lang.String bookmark,
                             DocumentContext ctx)

      This method is invoked when a bookmark starts.
      Parameters:
        `bookmark` - Name of bookmark
        `ctx` - DocumentContext

    - #### onBookmarkEnd

          void onBookmarkEnd(java.lang.String bookmark,
                           DocumentContext ctx)

      This method is invoked when a bookmark ends.
      Parameters:
        `bookmark` - Name of bookmark.
        `ctx` - DocumentContext

    - #### onInsertText

          java.lang.String onInsertText(java.lang.String text)

      This method is invoked when text is inserted.
      Parameters:
        `text` - Text that is inserted.
      Returns:
        Returns a modified text or `text`

© 2003-2011 by Sascha Schmidt (vision-cloud.de). All Rights Reserved.