Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.messages
Interface ISystemMessageLine

All Known Subinterfaces:
ISystemCompileCommandEditPaneHoster, ISystemUDAEditPaneHoster
All Known Implementing Classes:
AbstractSystemWizardPage, StatusLineManagerAdapter, SystemBasePropertyPage, SystemBuildErrorViewPart, SystemCommandsViewPart, SystemConnectionPropertyPage, SystemConnectionSubSystemsPropertyPage, SystemDialogPageMessageLine, SystemMessageLine, SystemNewConnectionWizardDefaultMainPage, SystemNewConnectionWizardRenameProfilePage, SystemNewProfileWizardMainPage, SystemPromptDialog, SystemScratchpadViewPart, SystemSearchViewPart, SystemSelectFileTypesDialog, SystemSubSystemPropertyPageCore, SystemTableViewPart, SystemTeamViewCompileCommandPropertyPage, SystemTeamViewPart, SystemTeamViewUserActionPropertyPage, SystemViewPart, SystemWorkWithCompileCommandsDialog, SystemWorkWithUDAsDialog, SystemWorkWithUDTypeDialog

public interface ISystemMessageLine

A message line interface. It distinguishs between "normal" messages and errors, as does the DialogPage classes in eclipse.

For each of those, however, we also support both simple string msgs and more robust SystemMessage messages. A dialog, wizard page or property page class that implements this interface will support these by using getLevelOneText() to get the string for the first level text, and support mouse clicking on the message to display the SystemMessageDialog class to show the 2nd level text.

Setting an error message hides a currently displayed message until clearErrorMessage is called.


Field Summary
static String copyright
           
 
Method Summary
 void clearErrorMessage()
          Clears the currently displayed error message and redisplayes the message which was active before the error message was set.
 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 exc)
          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
 

Field Detail

copyright

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

clearErrorMessage

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


clearMessage

public void clearMessage()
Clears the currently displayed message.


getErrorMessage

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

Returns:
The error message. If no error message is displayed null is returned.

getSystemErrorMessage

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

Returns:
The error message. If no error message is displayed null is returned.

getMessage

public String getMessage()
Get the currently displayed message.

Returns:
The message. If no 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.


setErrorMessage

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


setErrorMessage

public void setErrorMessage(Throwable exc)
Display the given exception as an error message. This is a convenience method... a generic SystemMessage is used for exceptions.


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


setMessage

public 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


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.