Fixed bug 149393: [console] Scrolling up in console should automatically behave like a lockI20141210-0800I20141209-2000I20141209-1115I20141209-0800I20141208-2000I20141208-0800I20141207-2000

Signed-off-by: Sarika Sinha <sarika.sinha@in.ibm.com>

6 files changed, 207 insertions, 37 deletions

diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/console/IConsoleView.java b/org.eclipse.ui.console/src/org/eclipse/ui/console/IConsoleView.java
index d15c7ff95..17628858d 100644
--- a/org.eclipse.ui.console/src/org/eclipse/ui/console/IConsoleView.java
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/console/IConsoleView.java
@@ -19,7 +19,7 @@ import org.eclipse.ui.IViewPart;
  * @noimplement This interface is not intended to be implemented by clients.
  * @noextend This interface is not intended to be extended by clients.
  */
-public interface IConsoleView extends IViewPart {
+public interface IConsoleView extends IViewPart, IScrollLockStateProvider {
 
 	/**
 	 * Displays the page for the given console in this console view.
@@ -82,7 +82,8 @@ public interface IConsoleView extends IViewPart {
      * @param scrollLock <code>true</code> to turn scroll lock on, otherwise <code>false</code>
      * @since 3.1
      */
-    public void setScrollLock(boolean scrollLock);
+    @Override
+	public void setScrollLock(boolean scrollLock);
 
     /**
      * Returns the scroll lock state of the currently active console.
@@ -90,7 +91,8 @@ public interface IConsoleView extends IViewPart {
      * @return <code>true</code> if scroll lock is on, <code>false</code> otherwise
      * @since 3.1
      */
-    public boolean getScrollLock();
+    @Override
+	public boolean getScrollLock();
 
 	/**
 	 * Sets the word wrap state of the currently active console.
diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/console/IScrollLockStateProvider.java b/org.eclipse.ui.console/src/org/eclipse/ui/console/IScrollLockStateProvider.java
new file mode 100644
index 000000000..457bd152a
--- /dev/null
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/console/IScrollLockStateProvider.java
@@ -0,0 +1,42 @@
+/*******************************************************************************
+ * Copyright (c) 2014 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;
+
+
+/**
+ * Scroll lock provider for the text console viewer.
+ * <p>
+ * This interface allows a text console viewer to control the scroll lock state of its container, e.g. a view.
+ * </p>
+ * <p>
+ * Clients may implement this interface.
+ * </p>
+ *
+ * @since 3.6
+ */
+public interface IScrollLockStateProvider {
+
+	/**
+	 * Sets the scroll lock state.
+	 *
+	 * @param scrollLock <code>true</code> to turn scroll lock on, otherwise
+	 *            <code>false</code>
+	 */
+	public void setScrollLock(boolean scrollLock);
+
+	/**
+	 * Returns the scroll lock state.
+	 *
+	 * @return <code>true</code> if scroll lock is on, <code>false</code>
+	 *         otherwise
+	 */
+	public boolean getScrollLock();
+}
diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/console/TextConsolePage.java b/org.eclipse.ui.console/src/org/eclipse/ui/console/TextConsolePage.java
index 9a97a3085..67e90d4e7 100644
--- a/org.eclipse.ui.console/src/org/eclipse/ui/console/TextConsolePage.java
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/console/TextConsolePage.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2013 IBM Corporation and others.
+ * Copyright (c) 2000, 2014 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
@@ -123,7 +123,7 @@ public class TextConsolePage implements IPageBookViewPage, IPropertyChangeListen
      * @return a viewer used to display the contents of this page's console
      */
 	protected TextConsoleViewer createViewer(Composite parent) {
-	    return new TextConsoleViewer(parent, fConsole);
+		return new TextConsoleViewer(parent, fConsole, fConsoleView);
 	}
 
     /*
diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/console/TextConsoleViewer.java b/org.eclipse.ui.console/src/org/eclipse/ui/console/TextConsoleViewer.java
index 82b775b8b..ce731beee 100644
--- a/org.eclipse.ui.console/src/org/eclipse/ui/console/TextConsoleViewer.java
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/console/TextConsoleViewer.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2013 IBM Corporation and others.
+ * Copyright (c) 2000, 2014 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
@@ -13,25 +13,8 @@ package org.eclipse.ui.console;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.atomic.AtomicBoolean;
 
-import org.eclipse.core.runtime.IProgressMonitor;
-import org.eclipse.core.runtime.IStatus;
-import org.eclipse.core.runtime.Status;
-import org.eclipse.jface.preference.JFacePreferences;
-import org.eclipse.jface.resource.ColorRegistry;
-import org.eclipse.jface.resource.JFaceColors;
-import org.eclipse.jface.resource.JFaceResources;
-import org.eclipse.jface.text.BadPositionCategoryException;
-import org.eclipse.jface.text.DocumentEvent;
-import org.eclipse.jface.text.IDocument;
-import org.eclipse.jface.text.IDocumentAdapter;
-import org.eclipse.jface.text.IDocumentListener;
-import org.eclipse.jface.text.IPositionUpdater;
-import org.eclipse.jface.text.IRegion;
-import org.eclipse.jface.text.Position;
-import org.eclipse.jface.text.source.SourceViewer;
-import org.eclipse.jface.util.IPropertyChangeListener;
-import org.eclipse.jface.util.PropertyChangeEvent;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.custom.LineBackgroundEvent;
 import org.eclipse.swt.custom.LineBackgroundListener;
@@ -39,10 +22,15 @@ import org.eclipse.swt.custom.LineStyleEvent;
 import org.eclipse.swt.custom.LineStyleListener;
 import org.eclipse.swt.custom.StyleRange;
 import org.eclipse.swt.custom.StyledText;
+import org.eclipse.swt.events.KeyAdapter;
+import org.eclipse.swt.events.KeyEvent;
 import org.eclipse.swt.events.MouseEvent;
 import org.eclipse.swt.events.MouseListener;
 import org.eclipse.swt.events.MouseMoveListener;
 import org.eclipse.swt.events.MouseTrackListener;
+import org.eclipse.swt.events.MouseWheelListener;
+import org.eclipse.swt.events.SelectionAdapter;
+import org.eclipse.swt.events.SelectionEvent;
 import org.eclipse.swt.graphics.Color;
 import org.eclipse.swt.graphics.Cursor;
 import org.eclipse.swt.graphics.Font;
@@ -52,6 +40,29 @@ import org.eclipse.swt.widgets.Control;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Event;
 import org.eclipse.swt.widgets.Listener;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+
+import org.eclipse.jface.preference.JFacePreferences;
+import org.eclipse.jface.resource.ColorRegistry;
+import org.eclipse.jface.resource.JFaceColors;
+import org.eclipse.jface.resource.JFaceResources;
+import org.eclipse.jface.util.IPropertyChangeListener;
+import org.eclipse.jface.util.PropertyChangeEvent;
+
+import org.eclipse.jface.text.BadPositionCategoryException;
+import org.eclipse.jface.text.DocumentEvent;
+import org.eclipse.jface.text.IDocument;
+import org.eclipse.jface.text.IDocumentAdapter;
+import org.eclipse.jface.text.IDocumentListener;
+import org.eclipse.jface.text.IPositionUpdater;
+import org.eclipse.jface.text.IRegion;
+import org.eclipse.jface.text.JFaceTextUtil;
+import org.eclipse.jface.text.Position;
+import org.eclipse.jface.text.source.SourceViewer;
+
 import org.eclipse.ui.internal.console.ConsoleDocumentAdapter;
 import org.eclipse.ui.internal.console.ConsoleHyperlinkPosition;
 import org.eclipse.ui.progress.WorkbenchJob;
@@ -82,6 +93,8 @@ public class TextConsoleViewer extends SourceViewer implements LineStyleListener
 
     private IPropertyChangeListener propertyChangeListener;
 
+	private IScrollLockStateProvider scrollLockStateProvider;
+
     private IDocumentListener documentListener = new IDocumentListener() {
         @Override
 		public void documentAboutToBeChanged(DocumentEvent event) {
@@ -111,18 +124,48 @@ public class TextConsoleViewer extends SourceViewer implements LineStyleListener
 		}
 	};
 
+	// to store to user scroll lock action
+	private AtomicBoolean userHoldsScrollLock = new AtomicBoolean(false);
+
     WorkbenchJob revealJob = new WorkbenchJob("Reveal End of Document") {//$NON-NLS-1$
         @Override
 		public IStatus runInUIThread(IProgressMonitor monitor) {
-            StyledText textWidget = getTextWidget();
-            if (textWidget != null && !textWidget.isDisposed()) {
-                int lineCount = textWidget.getLineCount();
-                textWidget.setTopIndex(lineCount - 1);
-            }
+			scrollToEndOfDocument();
             return Status.OK_STATUS;
         }
     };
 
+	// reveal the end of the document
+	private void scrollToEndOfDocument() {
+		StyledText textWidget = getTextWidget();
+		if (textWidget != null && !textWidget.isDisposed()) {
+			int lineCount = textWidget.getLineCount();
+			textWidget.setTopIndex(lineCount - 1);
+		}
+
+	}
+
+	// set the scroll Lock setting for Console Viewer and Console View
+	private void setScrollLock(boolean lock) {
+		userHoldsScrollLock.set(lock);
+		if (scrollLockStateProvider != null && scrollLockStateProvider.getScrollLock() != lock) {
+			scrollLockStateProvider.setScrollLock(lock);
+		}
+	}
+
+	// set the scroll Lock setting for Console Viewer and Console View
+	private boolean checkEndOfDocument() {
+		StyledText textWidget = getTextWidget();
+		if (textWidget != null && !textWidget.isDisposed()) {
+			int partialIndex = JFaceTextUtil.getPartialBottomIndex(textWidget);
+			int bottomLine = JFaceTextUtil.getLineIndex(textWidget, partialIndex);
+			int lineCount = textWidget.getLineCount();
+			int delta = textWidget.getVerticalBar().getIncrement() * 2;
+			return lineCount - bottomLine < delta;
+		}
+		return false;
+	}
+
     private IPositionUpdater positionUpdater = new IPositionUpdater() {
         @Override
 		public void update(DocumentEvent event) {
@@ -146,13 +189,26 @@ public class TextConsoleViewer extends SourceViewer implements LineStyleListener
     };
 
     /**
-     * Constructs a new viewer in the given parent for the specified console.
-     *
-     * @param parent
-     *            containing widget
-     * @param console
-     *            text console
-     */
+	 * Constructs a new viewer in the given parent for the specified console.
+	 *
+	 * @param parent the containing composite
+	 * @param console the text console
+	 * @param scrollLockStateProvider the scroll lock state provider
+	 * @since 3.6
+	 */
+	public TextConsoleViewer(Composite parent, TextConsole console, IScrollLockStateProvider scrollLockStateProvider) {
+		this(parent, console);
+		this.scrollLockStateProvider = scrollLockStateProvider;
+
+
+	}
+
+	/**
+	 * Constructs a new viewer in the given parent for the specified console.
+	 *
+	 * @param parent containing widget
+	 * @param console text console
+	 */
     public TextConsoleViewer(Composite parent, TextConsole console) {
         super(parent, null, SWT.V_SCROLL | SWT.H_SCROLL);
         this.console = console;
@@ -169,6 +225,58 @@ public class TextConsoleViewer extends SourceViewer implements LineStyleListener
         setFont(console.getFont());
         styledText.addMouseTrackListener(this);
         styledText.addListener(SWT.MouseUp, mouseUpListener);
+		// event listener used to send event to vertical scroll bar
+		styledText.getVerticalBar().addSelectionListener(new SelectionAdapter() {
+			@Override
+			public void widgetSelected(SelectionEvent e) {
+				// scroll lock if vertical scroll bar dragged, OR selection on
+				// vertical bar used
+				if (e.detail == SWT.TOP || e.detail == SWT.HOME || e.detail == SWT.ARROW_UP || e.detail == SWT.PAGE_UP) {
+					// selecting TOP or HOME should lock
+					setScrollLock(true);
+				} else if (e.detail == SWT.END || e.detail == SWT.BOTTOM) {
+					// selecting BOTTOM or END from vertical scroll makes it
+					// reveal the end
+					setScrollLock(false);
+				} else if (e.detail == SWT.DRAG) {
+					if (checkEndOfDocument()) {
+						setScrollLock(false);
+					} else {
+						setScrollLock(true);
+					}
+				} else if ((e.detail == SWT.PAGE_DOWN || e.detail == SWT.ARROW_DOWN) && checkEndOfDocument()) {
+					// unlock if Down at the end of document
+					setScrollLock(false);
+				}
+			}
+		});
+		styledText.addKeyListener(new KeyAdapter() {
+			@Override
+			public void keyPressed(KeyEvent e) {
+				// lock the scroll if PAGE_UP ,HOME or TOP selected
+				if (e.keyCode == SWT.PAGE_UP || e.keyCode == SWT.HOME || e.keyCode == SWT.TOP || e.keyCode == SWT.ARROW_UP) {
+					setScrollLock(true);
+				} else if (e.keyCode == SWT.END || e.keyCode == SWT.BOTTOM) {
+					setScrollLock(false);// selecting END makes it reveal the
+											// end
+				} else if ((e.keyCode == SWT.PAGE_DOWN || e.keyCode == SWT.ARROW_DOWN) && checkEndOfDocument()) {
+					// unlock if Down at the end of document
+					setScrollLock(false);
+				}
+			}
+		});
+		styledText.addMouseWheelListener(new MouseWheelListener() {
+			@Override
+			public void mouseScrolled(MouseEvent e) {
+				if (e.count < 0) { // Mouse dragged down
+					if (checkEndOfDocument()) {
+						setScrollLock(false);
+					}
+				} else if (!userHoldsScrollLock.get()) {
+					setScrollLock(true);
+				}
+			}
+		});
 
         ColorRegistry colorRegistry = JFaceResources.getColorRegistry();
         propertyChangeListener = new HyperlinkColorChangeListener();
@@ -722,4 +830,5 @@ public class TextConsoleViewer extends SourceViewer implements LineStyleListener
         }
     }
 
+
 }
diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/internal/console/IOConsolePage.java b/org.eclipse.ui.console/src/org/eclipse/ui/internal/console/IOConsolePage.java
index 79cb8702e..a31c6c093 100644
--- a/org.eclipse.ui.console/src/org/eclipse/ui/internal/console/IOConsolePage.java
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/internal/console/IOConsolePage.java
@@ -38,8 +38,11 @@ public class IOConsolePage extends TextConsolePage {
 
     private IPropertyChangeListener fPropertyChangeListener;
 
+	private IConsoleView fView;
+
     public IOConsolePage(TextConsole console, IConsoleView view) {
         super(console, view);
+		fView = view;
 
         fPropertyChangeListener = new IPropertyChangeListener() {
             @Override
@@ -64,7 +67,7 @@ public class IOConsolePage extends TextConsolePage {
 
     @Override
 	protected TextConsoleViewer createViewer(Composite parent) {
-        return new IOConsoleViewer(parent, (TextConsole)getConsole());
+		return new IOConsoleViewer(parent, (TextConsole) getConsole(), fView);
     }
 
     public void setAutoScroll(boolean scroll) {
@@ -132,6 +135,7 @@ public class IOConsolePage extends TextConsolePage {
             fWordWrapAction.dispose();
             fWordWrapAction = null;
         }
+        fView = null;
         getConsole().removePropertyChangeListener(fPropertyChangeListener);
         super.dispose();
     }
diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/internal/console/IOConsoleViewer.java b/org.eclipse.ui.console/src/org/eclipse/ui/internal/console/IOConsoleViewer.java
index 99322dc4c..2ede958dc 100644
--- a/org.eclipse.ui.console/src/org/eclipse/ui/internal/console/IOConsoleViewer.java
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/internal/console/IOConsoleViewer.java
@@ -20,6 +20,7 @@ import org.eclipse.swt.events.VerifyEvent;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.ui.console.ConsolePlugin;
 import org.eclipse.ui.console.IConsoleDocumentPartitioner;
+import org.eclipse.ui.console.IScrollLockStateProvider;
 import org.eclipse.ui.console.TextConsole;
 import org.eclipse.ui.console.TextConsoleViewer;
 
@@ -42,6 +43,18 @@ public class IOConsoleViewer extends TextConsoleViewer {
         super(parent, console);
     }
 
+	/**
+	 * Constructs a new viewer in the given parent for the specified console.
+	 *
+	 * @param parent the containing composite
+	 * @param console the IO console
+	 * @param scrollLockStateProvider the scroll lock state provider
+	 * @since 3.6
+	 */
+	public IOConsoleViewer(Composite parent, TextConsole console, IScrollLockStateProvider scrollLockStateProvider) {
+		super(parent, console, scrollLockStateProvider);
+	}
+
     public boolean isAutoScroll() {
         return fAutoScroll;
     }