org.eclipse.rse.ui.messages
Class SystemMessageLine

java.lang.Object
  

org.eclipse.swt.widgets.Widget
      

org.eclipse.swt.widgets.Control
          

org.eclipse.swt.widgets.Scrollable
              

org.eclipse.swt.widgets.Composite
                  
org.eclipse.rse.ui.messages.SystemMessageLine

All Implemented Interfaces:

ISystemMessageLine, Drawable

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.

Field Summary

 

Fields inherited from class org.eclipse.swt.widgets. Composite
embeddedHandle

 

Fields inherited from class org.eclipse.swt.widgets. Widget
handle

 

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 redisplayes the non-error message which was active before the error message was set (if any).
void	clearMessage ()           Clears the currently displayed message.
String	getErrorMessage ()           Get the currently displayed error text.
String	getMessage ()           Get the currently displayed message.
SystemMessage	getSystemErrorMessage ()           Get the currently displayed error text.
void	setErrorMessage ( String message)           Display the given error message.
void	setErrorMessage ( SystemMessage message)           Display the given error message.
void	setErrorMessage ( Throwable throwable)           Display the given exception as an error message.
void	setMessage ( String message)           Set the message text.
void	setMessage ( SystemMessage message)           If the message line currently displays an error, the message is stored and will be shown after a call to clearErrorMessage

 

Methods inherited from class org.eclipse.swt.widgets. Composite
changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getClientArea, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

 

Methods inherited from class org.eclipse.swt.widgets. Scrollable
computeTrim, getBorderWidth, getHorizontalBar, getVerticalBar

 

Methods inherited from class org.eclipse.swt.widgets. Control

addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getData, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

 

Methods inherited from class org.eclipse.swt.widgets. Widget
addDisposeListener, addListener, checkWidget, dispose, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

 

Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

SystemMessageLine

public SystemMessageLine(
Composite parent)

Creates a new message line as a child of the given parent. If the parent uses a grid layout then the layout data is set. If not then the layout data must be set by the creator to match the layout of the parent composite.

clearMessage

public void clearMessage()

Description copied from interface: ISystemMessageLine

Clears the currently displayed message.

Specified by:

clearMessage in interface ISystemMessageLine

clearErrorMessage

public void clearErrorMessage()

Description copied from interface: ISystemMessageLine

Clears the currently displayed error message and redisplayes the non-error message which was active before the error message was set (if any).

Specified by:

clearErrorMessage in interface ISystemMessageLine

setMessage

public void setMessage(
SystemMessage message)

Description copied from interface: ISystemMessageLine

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(
String message)

Description copied from interface: ISystemMessageLine

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

setErrorMessage

public void setErrorMessage(
String message)

Description copied from interface: ISystemMessageLine

Display the given error message. A currently displayed (non-error) 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 (non-error) message is saved and will be redisplayed when the error message is cleared.

Specified by:

setErrorMessage in interface ISystemMessageLine

setErrorMessage

public void setErrorMessage(
Throwable throwable)

Description copied from interface: ISystemMessageLine

Display the given exception as an error message. This is a convenience method... a generic SystemMessage is used for exceptions.

Specified by:

setErrorMessage in interface ISystemMessageLine

getMessage

public 
String getMessage()

Description copied from interface: ISystemMessageLine

Get the currently displayed message.

Specified by:

getMessage in interface ISystemMessageLine

Returns:

The message. If no message is displayed null is returned.

public 
String getErrorMessage()

public 
SystemMessage getSystemErrorMessage()