org.eclipse.debug.ui.console.IConsoleLineTracker Maven / Gradle / Ivy

Go to download

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

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

The newest version!

/*******************************************************************************
 * Copyright (c) 2000, 2005 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.debug.ui.console;


import org.eclipse.jface.text.IRegion;

/**
 * Notified of lines appended to the console. A line tracker is defined in
 * plugin.xml. A line tracker is associated with a type of
 * process. Following is an example definition of a console line tracker
 * extension.
 *  * <extension point="org.eclipse.debug.ui.consoleLineTrackers">
 *   <consoleLineTracker 
 *      id="com.example.ExampleConsoleLineTracker"
 *      class="com.example.ExampleConsoleLineTrackerClass"
 *      processType="ExampleProcessType">
 *   </consoleLineTracker>
 * </extension>
 * 
 * The attributes are specified as follows:
 * 
 * id specifies a unique identifier for this line tracker.
 * class specifies a fully qualified name of a Java class
 *  that implements IConsoleLineTracker.
 * processType specifies the identifier of the process type
 * this line tracker is associated with (which corresponds to the
 * ATTR_PROCESS_TYPE attribute on a process).
 * 
 * 
 * Clients may implement this interface.
 * 
 * @since 2.1
 */
public interface IConsoleLineTracker {
	
	/**
	 * Notification that a console document has been created for which this
	 * listener is registered. 
	 *  
	 * @param console console that has been created
	 */
	public void init(IConsole console);

	/**
	 * Notification that a line of text has been appended to the console. The
	 * given region describes the offset and length of the line appended to the
	 * console, excluding the line delimiter.
	 * 
	 * @param line region describing the offset and length of line appended to
	 * the console, excluding the line delimiter
	 */
	public void lineAppended(IRegion line);
	
	/**
	 * Disposes this console line tracker. 
	 */
	public void dispose();
}