Package org.eclipse.jface.text.link
Interface ILinkedModeListener
-
public interface ILinkedModeListener
Protocol used byLinkedModeModel
s 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 int
EXIT_ALL
Flag toleave
specifying that all nested modes should exit.static int
EXTERNAL_MODIFICATION
Flag toleave
specifying that document content outside of a linked position was modified.static int
NONE
Flag toleave
specifying no special action.static int
SELECT
Flag toleave
specifying that a UI of a parent mode should select the current position.static int
UPDATE_CARET
Flag toleave
specifying that the caret should be moved to the exit position.
-
Method Summary
All Methods Instance Methods Abstract Methods 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 withinmodel
.
-
-
-
Field Detail
-
NONE
static final int NONE
Flag toleave
specifying no special action.- See Also:
- Constant Field Values
-
EXIT_ALL
static final int EXIT_ALL
Flag toleave
specifying that all nested modes should exit.- See Also:
- Constant Field Values
-
UPDATE_CARET
static final int UPDATE_CARET
Flag toleave
specifying that the caret should be moved to the exit position.- See Also:
- Constant Field Values
-
SELECT
static final int SELECT
Flag toleave
specifying that a UI of a parent mode should select the current position.- See Also:
- Constant Field Values
-
EXTERNAL_MODIFICATION
static final int EXTERNAL_MODIFICATION
Flag toleave
specifying that document content outside of a linked position was modified.- See Also:
- Constant Field Values
-
-
Method Detail
-
left
void left(LinkedModeModel model, int flags)
The leave event occurs when linked is left.- Parameters:
model
- the model being leftflags
- the reason and commands for leaving linked mode
-
suspend
void suspend(LinkedModeModel model)
The suspend event occurs when a nested linked mode is installed withinmodel
.- 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 exitingflags
- the commands to execute when resuming after suspend
-
-