Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.messages
Class SystemMessageLine

java.lang.Object
  extended byComposite
      extended bycom.ibm.etools.systems.core.ui.messages.SystemMessageLine
All Implemented Interfaces:
ISystemMessageLine

public class SystemMessageLine
extends Composite
implements ISystemMessageLine

A message line. It distinguishs between "normal" messages and errors. Setting an error message hides a currently displayed message until clearErrorMessage is called.

See Also:
Serialized Form

Field Summary
static String copyright
           
 
Constructor Summary
SystemMessageLine(Composite parent)
          Creates a new message line as a child of the given parent.
 
Method Summary
 void clearErrorMessage()
          Clears the currently displayed error message and redisplays the non-error message which was active before the error message was set.
 void clearMessage()
          Clears the currently displayed message.
 void dispose()
          Dispose resources.
protected  Color getErrorColor()
          return the color to use for error text
 String getErrorMessage()
          Get the currently displayed error text.
protected  Color getInformationColor()
          return the color to use for information text
 String getMessage()
          Get the currently displayed message.
 SystemMessage getSystemErrorMessage()
          Get the currently displayed error text.
protected  Color getWarningColor()
          return the color to use for warning text
 void setErrorMessage(String message)
          Display the given error message.
 void setErrorMessage(SystemMessage message)
          Display the given error message.
 void setErrorMessage(Throwable exc)
          Convenience method to set an error message from an exception
 void setMessage(String message)
          Set the message text.
 void setMessage(SystemMessage message)
          Set the non-error message text, via a SystemMessage object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Constructor Detail

SystemMessageLine

public SystemMessageLine(Composite parent)
Creates a new message line as a child of the given parent. Error message will be shown with in the rgb color 255,0,0.

Method Detail

clearErrorMessage

public void clearErrorMessage()
Clears the currently displayed error message and redisplays the non-error message which was active before the error message was set.

Specified by:
clearErrorMessage in interface ISystemMessageLine

clearMessage

public void clearMessage()
Clears the currently displayed message.

Specified by:
clearMessage in interface ISystemMessageLine

getErrorMessage

public String getErrorMessage()
Get the currently displayed error text.

Specified by:
getErrorMessage in interface ISystemMessageLine
Returns:
The error message. If no error message is displayed null is returned.

getMessage

public String getMessage()
Get the currently displayed message.

Specified by:
getMessage in interface ISystemMessageLine
Returns:
The message. If no message is displayed null is returned.

getSystemErrorMessage

public SystemMessage getSystemErrorMessage()
Get the currently displayed error text.

Specified by:
getSystemErrorMessage in interface ISystemMessageLine
Returns:
The error message. If no error message is displayed null is returned.

setErrorMessage

public void setErrorMessage(String message)
Display the given error message. A currently displayed message is saved and will be redisplayed when the error message is cleared.

Specified by:
setErrorMessage in interface ISystemMessageLine

setErrorMessage

public void setErrorMessage(SystemMessage message)
Description copied from interface: ISystemMessageLine
Display the given error message. A currently displayed message is saved and will be redisplayed when the error message is cleared.

Specified by:
setErrorMessage in interface ISystemMessageLine

setErrorMessage

public void setErrorMessage(Throwable exc)
Convenience method to set an error message from an exception

Specified by:
setErrorMessage in interface ISystemMessageLine

getErrorColor

protected Color getErrorColor()
return the color to use for error text


getWarningColor

protected Color getWarningColor()
return the color to use for warning text


getInformationColor

protected Color getInformationColor()
return the color to use for information text


setMessage

public void setMessage(String message)
Set the message text. If the message line currently displays an error, the message is stored and will be shown after a call to clearErrorMessage

Specified by:
setMessage in interface ISystemMessageLine

setMessage

public void setMessage(SystemMessage message)
Set the non-error message text, via a SystemMessage object. If the message line currently displays an error, the message is stored and will be shown after a call to clearErrorMessage

Specified by:
setMessage in interface ISystemMessageLine

dispose

public void dispose()
Dispose resources.


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.