Issue #111: Add a show on content change action to the toolbar for all Microclimate consoles

Author: eharris369

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/console/SocketConsole.java

@@ -30,6 +30,7 @@ public class SocketConsole extends IOConsole {
 
 	private IOConsoleOutputStream outputStream;
 	private boolean isInitialized = false;
+	private boolean showOnUpdate = false;
 
 	public SocketConsole(String consoleName, ProjectLogInfo logInfo, MicroclimateApplication app) {
 		super(consoleName, MicroclimateConsoleFactory.MC_CONSOLE_TYPE,
@@ -58,6 +59,9 @@ public void update(String contents, boolean reset) throws IOException {
 
 		MCLogger.log("Appending contents to log: " + this.getName());		// $NON-NLS-1$
 		outputStream.write(contents);
+		if (showOnUpdate) {
+			activate();
+		}
 	}
 
 	@Override
@@ -75,4 +79,8 @@ protected void dispose() {
 
 		super.dispose();
 	}
+	
+	public void setShowOnUpdate(boolean value) {
+		showOnUpdate = value;
+	}
 }

dev/com.ibm.microclimate.ui/plugin.xml

@@ -260,5 +260,15 @@
 			markerType="com.ibm.microclimate.core.validationMarker"
 			class="com.ibm.microclimate.ui.internal.marker.MicroclimateMarkerResolutionGenerator"/>
 	</extension>
+	
+	<extension point="org.eclipse.ui.console.consolePageParticipants">
+      <consolePageParticipant
+      		id="com.ibm.microclimate.ui.socketConsolePageParticipant"
+            class="com.ibm.microclimate.ui.internal.console.SocketConsolePageParticipant">
+         <enablement>
+            <instanceof value="com.ibm.microclimate.core.internal.console.SocketConsole"/>
+         </enablement>
+      </consolePageParticipant>
+   </extension>
 
 </plugin>

dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/console/ShowOnContentChangeAction.java

@@ -0,0 +1,40 @@
+/*******************************************************************************
+ * Copyright (c) 2019 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
+package com.ibm.microclimate.ui.internal.console;
+
+import org.eclipse.debug.internal.ui.IInternalDebugUIConstants;
+import org.eclipse.debug.ui.DebugUITools;
+import org.eclipse.jface.action.Action;
+import org.eclipse.jface.action.IAction;
+
+import com.ibm.microclimate.core.internal.console.SocketConsole;
+import com.ibm.microclimate.ui.MicroclimateUIPlugin;
+import com.ibm.microclimate.ui.internal.messages.Messages;
+
+public class ShowOnContentChangeAction extends Action {
+	
+	SocketConsole console;
+	
+	public ShowOnContentChangeAction(SocketConsole console) {
+		super(Messages.ShowOnContentChangeAction, IAction.AS_CHECK_BOX);
+		setToolTipText(Messages.ShowOnContentChangeAction);
+		setId(MicroclimateUIPlugin.PLUGIN_ID + ".ShowOnContentChangeAction"); //$NON-NLS-1$
+        setImageDescriptor(DebugUITools.getImageDescriptor(IInternalDebugUIConstants.IMG_ELCL_STANDARD_OUT));
+		this.console = console;
+	}
+
+	@Override
+	public void run() {
+		console.setShowOnUpdate(isChecked());
+	}
+	
+}

dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/console/SocketConsolePageParticipant.java

@@ -0,0 +1,57 @@
+/*******************************************************************************
+ * Copyright (c) 2019 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
+package com.ibm.microclimate.ui.internal.console;
+
+import org.eclipse.jface.action.IToolBarManager;
+import org.eclipse.ui.IActionBars;
+import org.eclipse.ui.console.IConsole;
+import org.eclipse.ui.console.IConsoleConstants;
+import org.eclipse.ui.console.IConsolePageParticipant;
+import org.eclipse.ui.part.IPageBookViewPage;
+
+import com.ibm.microclimate.core.internal.console.SocketConsole;
+
+public class SocketConsolePageParticipant implements IConsolePageParticipant {
+
+	@Override
+	public <T> T getAdapter(Class<T> arg0) {
+		return null;
+	}
+
+	@Override
+	public void activated() {
+		// Empty
+	}
+
+	@Override
+	public void deactivated() {
+		// Empty
+	}
+
+	@Override
+	public void dispose() {
+		// Empty
+	}
+
+	@Override
+	public void init(IPageBookViewPage page, IConsole console) {
+		if (console instanceof SocketConsole) {
+			ShowOnContentChangeAction contentChange = new ShowOnContentChangeAction((SocketConsole)console);
+			
+			// Contribute to the toolbar
+	        IActionBars actionBars = page.getSite().getActionBars();
+	        IToolBarManager mgr = actionBars.getToolBarManager();
+	        mgr.appendToGroup(IConsoleConstants.OUTPUT_GROUP, contentChange);
+		}
+	}
+
+}

dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/messages/Messages.java

@@ -71,6 +71,7 @@ public class Messages extends NLS {
 	public static String ShowAllLogFilesAction;
 	public static String HideAllLogFilesAction;
 	public static String ErrorOnShowLogFileDialogTitle;
+	public static String ShowOnContentChangeAction;
 
 	public static String ActionNewConnection;
 

dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/messages/messages.properties

@@ -64,6 +64,7 @@ ShowLogFilesMenu=&Show Log Files
 ShowAllLogFilesAction=&Show All
 HideAllLogFilesAction=&Hide All
 ErrorOnShowLogFileDialogTitle=An error occurred while opening or closing the stream for the log file.
+ShowOnContentChangeAction=Show on Content Change
 
 ActionNewConnection=&New Microclimate Connection