Package org.eclipse.ui.console
Interface IScrollLockStateProvider
-
- All Known Subinterfaces:
IConsoleView
public interface IScrollLockStateProviderA scroll lock provider allows a client to control the scroll lock state of its container, e.g. a view.Clients may implement this interface.
- Since:
- 3.6
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleangetAutoScrollLock()Returns the auto-scroll lock state.booleangetScrollLock()Returns the scroll lock state that got explicitly set by the user, e.g.voidsetAutoScrollLock(boolean scrollLock)Sets the auto-scroll lock state, e.g. when the user moves the caret upwards in a console.voidsetScrollLock(boolean scrollLock)Sets the scroll lock state that got explicitly set by the user, e.g. by pressing a button that controls the state.
-
-
-
Method Detail
-
setScrollLock
void setScrollLock(boolean scrollLock)
Sets the scroll lock state that got explicitly set by the user, e.g. by pressing a button that controls the state.- Parameters:
scrollLock-trueto turn scroll lock on, otherwisefalse
-
getScrollLock
boolean getScrollLock()
Returns the scroll lock state that got explicitly set by the user, e.g. by pressing a button that controls the state.- Returns:
trueif scroll lock is on,falseotherwise
-
setAutoScrollLock
void setAutoScrollLock(boolean scrollLock)
Sets the auto-scroll lock state, e.g. when the user moves the caret upwards in a console.- Parameters:
scrollLock-trueto turn auto-scroll lock on, otherwisefalse
-
getAutoScrollLock
boolean getAutoScrollLock()
Returns the auto-scroll lock state.- Returns:
trueif auto-scroll lock is on,falseotherwise- See Also:
setAutoScrollLock(boolean)
-
-