Package org.eclipse.jface.text.link
Interface ILinkedModeListener
-
public interface ILinkedModeListenerProtocol used byLinkedModeModels 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 intEXIT_ALLFlag toleavespecifying that all nested modes should exit.static intEXTERNAL_MODIFICATIONFlag toleavespecifying that document content outside of a linked position was modified.static intNONEFlag toleavespecifying no special action.static intSELECTFlag toleavespecifying that a UI of a parent mode should select the current position.static intUPDATE_CARETFlag toleavespecifying that the caret should be moved to the exit position.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidleft(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 Detail
-
NONE
static final int NONE
Flag toleavespecifying no special action.- See Also:
- Constant Field Values
-
EXIT_ALL
static final int EXIT_ALL
Flag toleavespecifying that all nested modes should exit.- See Also:
- Constant Field Values
-
UPDATE_CARET
static final int UPDATE_CARET
Flag toleavespecifying that the caret should be moved to the exit position.- See Also:
- Constant Field Values
-
SELECT
static final int SELECT
Flag toleavespecifying 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 toleavespecifying 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
-
-