Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.console
Class MessageConsole

java.lang.Object
  extended by 

org.eclipse.ui.console.AbstractConsole
      extended by 

org.eclipse.ui.console.TextConsole
          extended by 

org.eclipse.ui.console.IOConsole
              extended by 
org.eclipse.ui.console.MessageConsole
All Implemented Interfaces:
IConsole

public class MessageConsole
extends IOConsole

A console that displays messages. A message console may have one or more streams connected to it (MessageConsoleStream). Text written to streams is buffered and processed in a Job by the console's document partitioner.

Clients may instantiate this class.

Since:
3.0
Restriction:
This class is not intended to be subclassed by clients.

Field Summary
static int DEFAULT_TAB_SIZE
          Deprecated. use IConsoleConstants.DEFAULT_TAB_SIZE
static  String P_FONT
          Deprecated. use IConsoleConstants.P_FONT
static  String P_STREAM_COLOR
          Deprecated. use IConsoleConstants.P_STREAM_COLOR
static  String P_TAB_SIZE
          Deprecated. use IConsoleConstants.P_TAB_SIZE
 
Constructor Summary
MessageConsole ( String name, ImageDescriptor imageDescriptor)
          Constructs a message console with the given name and image.
MessageConsole ( String name, ImageDescriptor imageDescriptor, boolean autoLifecycle)
          Constructs a message console.
MessageConsole ( String name, String consoleType, ImageDescriptor imageDescriptor, boolean autoLifecycle)
          Constructs a message console with the given name, type, image, and lifecycle.
 
Method Summary
protected  void appendToDocument ( String text, MessageConsoleStream stream)
          Deprecated. since 3.1, this method should no longer be called, and has no effect. Writing to a message console stream updates the document
  IPageBookViewPage createPage ( IConsoleView view)
          Creates and returns a new page for this console.
  IOConsoleInputStream getInputStream ()
          Returns the input stream connected to the keyboard.
  MessageConsoleStream newMessageStream ()
          Returns a new message stream connected to this console.
 
Methods inherited from class org.eclipse.ui.console. IOConsole
clearConsole, dispose, getEncoding, getHighWaterMark, getLowWaterMark, getPartitioner, newOutputStream, setWaterMarks
 
Methods inherited from class org.eclipse.ui.console. TextConsole
addHyperlink, addPatternMatchListener, getAttribute, getBackground, getConsoleWidth, getDocument, getFont, getHyperlink, getHyperlinks, getRegion, getSchedulingRule, getTabWidth, matcherFinished, partitionerFinished, removePatternMatchListener, setAttribute, setBackgrond, setBackground, setConsoleWidth, setFont, setTabWidth
 
Methods inherited from class org.eclipse.ui.console. AbstractConsole
activate, addPropertyChangeListener, destroy, firePropertyChange, getHelpContextId, getImageDescriptor, getName, getType, init, initialize, removePropertyChangeListener, setImageDescriptor, setName, setType
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

P_FONT

public static final 
String P_FONT
Deprecated. use IConsoleConstants.P_FONT
Property constant indicating the font of this console has changed.


P_STREAM_COLOR

public static final 
String P_STREAM_COLOR
Deprecated. use IConsoleConstants.P_STREAM_COLOR
Property constant indicating the color of a stream has changed.


P_TAB_SIZE

public static final 
String P_TAB_SIZE
Deprecated. use IConsoleConstants.P_TAB_SIZE
Property constant indicating tab size has changed


DEFAULT_TAB_SIZE

public static final int DEFAULT_TAB_SIZE
Deprecated. use IConsoleConstants.DEFAULT_TAB_SIZE
The default tab size

See Also:
Constant Field Values
Constructor Detail

MessageConsole

public MessageConsole(
String name,
                      
ImageDescriptor imageDescriptor)
Constructs a message console with the given name and image.

Parameters:
name - console name
imageDescriptor - console image descriptor or null

MessageConsole

public MessageConsole(
String name,
                      
ImageDescriptor imageDescriptor,
                      boolean autoLifecycle)
Constructs a message console.

Parameters:
name - console name
imageDescriptor - console image descriptor or null
autoLifecycle - whether lifecycle methods should be called automatically when added and removed from the console manager
Since:
3.1

MessageConsole

public MessageConsole(
String name,
                      
String consoleType,
                      
ImageDescriptor imageDescriptor,
                      boolean autoLifecycle)
Constructs a message console with the given name, type, image, and lifecycle.

Parameters:
name - console name
consoleType - console type identifier or null
imageDescriptor - console image descriptor or null
autoLifecycle - whether lifecycle methods should be called automatically when added and removed from the console manager
Since:
3.4
Method Detail

newMessageStream

public 
MessageConsoleStream newMessageStream()
Returns a new message stream connected to this console.

Clients should avoid writing large amounts of output to this stream in the UI thread. The console needs to process the output in the UI thread and if the client hogs the UI thread writing output to the console, the console will not be able to process the output.

Returns:
a new message stream connected to this console

createPage

public 
IPageBookViewPage createPage(
IConsoleView view)
Description copied from interface: IConsole
Creates and returns a new page for this console. The page is displayed for this console in the console given view.

Specified by:
createPage in interface IConsole
Overrides:
createPage in class IOConsole
Parameters:
view - the view in which the page is to be created
Returns:
a page book view page representation of this console

getInputStream

public 
IOConsoleInputStream getInputStream()
Description copied from class: IOConsole
Returns the input stream connected to the keyboard.

Overrides:
getInputStream in class IOConsole
Returns:
the input stream connected to the keyboard.

appendToDocument

protected void appendToDocument(
String text,
                                
MessageConsoleStream stream)
Deprecated. since 3.1, this method should no longer be called, and has no effect. Writing to a message console stream updates the document

Appends the given message to this console, from the specified stream.

Parameters:
text - message
stream - stream the message belongs to

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire