Package com.myscript.iink

Interface IOffscreenGestureHandler

public interface IOffscreenGestureHandler
The listener interface for handling offscreen gesture events.
Since:
2.1
See Also:

  • Method Details

    • onUnderline

      @NotNull @NotNull OffscreenGestureAction onUnderline(@NotNull @NotNull OffscreenEditor editor, @NotNull @NotNull String gestureStrokeId, @NotNull @NotNull String[] itemIds)
      Invoked when a portion of text has been underlined. To activate underline detection in a Raw Content part, add "underline" to the "raw-content.pen.gestures" configuration list.
      Parameters:
      editor - the offscreen editor.
      gestureStrokeId - the id of the gesture stroke.
      itemIds - the underlined portion of text.
      Returns:
      the OffscreenGestureAction to perform.

    • onSurround

      @NotNull @NotNull OffscreenGestureAction onSurround(@NotNull @NotNull OffscreenEditor editor, @NotNull @NotNull String gestureStrokeId, @NotNull @NotNull String[] itemIds)
      Invoked when a portion of text has been surrounded. To activate surround detection in a Raw Content part, add "surround" to the "raw-content.pen.gestures" configuration list.
      Parameters:
      editor - the offscreen editor.
      gestureStrokeId - the id of the gesture stroke.
      itemIds - the surrounded portion of text.
      Returns:
      the OffscreenGestureAction to perform.

    • onJoin

      @NotNull @NotNull OffscreenGestureAction onJoin(@NotNull @NotNull OffscreenEditor editor, @NotNull @NotNull String gestureStrokeId, @NotNull @NotNull String[] before, @NotNull @NotNull String[] after)
      Invoked when a join gesture has been drawn between two portions of a text line, or at the beginning or end of a line. To activate join detection in a Raw Content part, add "join" to the "raw-content.pen.gestures" configuration list.
      Parameters:
      editor - the offscreen editor.
      gestureStrokeId - the id of the gesture stroke.
      before - the portion of the text line before the join gesture.
      after - the portion of the text line after the join gesture.
      Returns:
      the OffscreenGestureAction to perform.

    • onInsert

      @NotNull @NotNull OffscreenGestureAction onInsert(@NotNull @NotNull OffscreenEditor editor, @NotNull @NotNull String gestureStrokeId, @NotNull @NotNull String[] before, @NotNull @NotNull String[] after)
      Invoked when an insert gesture has been drawn between two portions of a text line, or at the beginning or end of a line. To activate insert detection in a Raw Content part, add "insert" to the "raw-content.pen.gestures" configuration list.
      Parameters:
      editor - the offscreen editor.
      gestureStrokeId - the id of the gesture stroke.
      before - the portion of the text line before the insert gesture.
      after - the portion of the text line after the insert gesture.
      Returns:
      the OffscreenGestureAction to perform.

    • onStrikethrough

      @NotNull @NotNull OffscreenGestureAction onStrikethrough(@NotNull @NotNull OffscreenEditor editor, @NotNull @NotNull String gestureStrokeId, @NotNull @NotNull String[] itemIds)
      Invoked when a portion of text has been striked through. To activate strikethrough detection in a Raw Content part, add "strike-through" to the "raw-content.pen.gestures" configuration list.
      Parameters:
      editor - the offscreen editor.
      gestureStrokeId - the id of the gesture stroke.
      itemIds - the striked through portion of text.
      Returns:
      the OffscreenGestureAction to perform.

    • onScratch

      @NotNull @NotNull OffscreenGestureAction onScratch(@NotNull @NotNull OffscreenEditor editor, @NotNull @NotNull String gestureStrokeId, @NotNull @NotNull String[] itemIds)
      Invoked when a portion of text has been scratched. To activate scratch detection in a Raw Content part, add "scratch-out" to the "raw-content.pen.gestures" configuration list.
      Parameters:
      editor - the offscreen editor.
      gestureStrokeId - the id of the gesture stroke.
      itemIds - the scratched portion of text.
      Returns:
      the OffscreenGestureAction to perform.