org.eclipse.ui.console.IScrollLockStateProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.console Show documentation

This is org.eclipse.ui.console jar used by Scout SDK

The newest version!

/*******************************************************************************
 * Copyright (c) 2014, 2015 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 * *******************************************************************************/
package org.eclipse.ui.console;


/**
 * A 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
 */
public interface IScrollLockStateProvider {

	/**
	 * Sets the scroll lock state that got explicitly set by the user, e.g. by
	 * pressing a button that controls the state.
	 *
	 * @param scrollLock true to turn scroll lock on, otherwise
	 *            false
	 */
	public void setScrollLock(boolean scrollLock);


	/**
	 * Returns the scroll lock state that got explicitly set by the user, e.g.
	 * by pressing a button that controls the state.
	 *
	 * @return true if scroll lock is on, false
	 *         otherwise
	 */
	public boolean getScrollLock();

	/**
	 * Sets the auto-scroll lock state, e.g. when the user moves the caret
	 * upwards in a console.
	 *
	 * @param scrollLock true to turn auto-scroll lock on,
	 *            otherwise false
	 */
	public void setAutoScrollLock(boolean scrollLock);

	/**
	 * Returns the auto-scroll lock state.
	 *
	 * @see #setAutoScrollLock(boolean)
	 * @return true if auto-scroll lock is on, false
	 *         otherwise
	 */
	public boolean getAutoScrollLock();
}