Package org.eclipse.jface.text.link

Interface ILinkedModeListener

public interface ILinkedModeListener
Protocol used by LinkedModeModels to communicate state changes, such as leaving linked mode, suspending it due to a child mode coming up, and resuming after a child mode has left.

This interface may implemented by clients.

Since:
3.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EXIT_ALL
    Flag to leave specifying that all nested modes should exit.
    static final int
    EXTERNAL_MODIFICATION
    Flag to leave specifying that document content outside of a linked position was modified.
    static final int
    NONE
    Flag to leave specifying no special action.
    static final int
    SELECT
    Flag to leave specifying that a UI of a parent mode should select the current position.
    static final int
    UPDATE_CARET
    Flag to leave specifying that the caret should be moved to the exit position.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    left(LinkedModeModel model, int flags)
    The leave event occurs when linked is left.
    void
    resume(LinkedModeModel model, int flags)
    The resume event occurs when a nested linked mode exits.
    void
    suspend(LinkedModeModel model)
    The suspend event occurs when a nested linked mode is installed within model.

  • Field Details

    • NONE

      static final int NONE
      Flag to leave specifying no special action.
      See Also:

    • EXIT_ALL

      static final int EXIT_ALL
      Flag to leave specifying that all nested modes should exit.
      See Also:

    • UPDATE_CARET

      static final int UPDATE_CARET
      Flag to leave specifying that the caret should be moved to the exit position.
      See Also:

    • SELECT

      static final int SELECT
      Flag to leave specifying that a UI of a parent mode should select the current position.
      See Also:

    • EXTERNAL_MODIFICATION

      static final int EXTERNAL_MODIFICATION
      Flag to leave specifying that document content outside of a linked position was modified.
      See Also:

  • Method Details

    • left

      void left(LinkedModeModel model, int flags)
      The leave event occurs when linked is left.
      Parameters:
      model - the model being left
      flags - the reason and commands for leaving linked mode

    • suspend

      void suspend(LinkedModeModel model)
      The suspend event occurs when a nested linked mode is installed within model.
      Parameters:
      model - the model being suspended due to a nested model being installed

    • resume

      void resume(LinkedModeModel model, int flags)
      The resume event occurs when a nested linked mode exits.
      Parameters:
      model - the linked mode model being resumed due to a nested mode exiting
      flags - the commands to execute when resuming after suspend