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
FieldsModifier and TypeFieldDescriptionstatic final intFlag toleavespecifying that all nested modes should exit.static final intFlag toleavespecifying that document content outside of a linked position was modified.static final intFlag toleavespecifying no special action.static final intFlag toleavespecifying that a UI of a parent mode should select the current position.static final intFlag toleavespecifying that the caret should be moved to the exit position. -
Method Summary
Modifier and TypeMethodDescriptionvoidleft(LinkedModeModel model, int flags) The leave event occurs when linked is left.voidresume(LinkedModeModel model, int flags) The resume event occurs when a nested linked mode exits.voidsuspend(LinkedModeModel model) The suspend event occurs when a nested linked mode is installed withinmodel.
-
Field Details
-
NONE
static final int NONEFlag toleavespecifying no special action.- See Also:
-
EXIT_ALL
static final int EXIT_ALLFlag toleavespecifying that all nested modes should exit.- See Also:
-
UPDATE_CARET
static final int UPDATE_CARETFlag toleavespecifying that the caret should be moved to the exit position.- See Also:
-
SELECT
static final int SELECTFlag toleavespecifying that a UI of a parent mode should select the current position.- See Also:
-
EXTERNAL_MODIFICATION
static final int EXTERNAL_MODIFICATIONFlag toleavespecifying that document content outside of a linked position was modified.- See Also:
-
-
Method Details
-
left
The leave event occurs when linked is left.- Parameters:
model- the model being leftflags- the reason and commands for leaving linked mode
-
suspend
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
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
-