|
|
|
|
org.eclipse.rse.ui.messages
Interface ISystemMessageLine
-
All Known Implementing Classes:
-
AbstractSystemNewConnectionWizardPage,
AbstractSystemWizardPage,
EnvironmentVariablesPromptDialog,
RSEDialogPageMessageLine,
ServicesPropertyPage,
StatusLineManagerAdapter,
SubSystemServiceWizardPage,
SystemBasePropertyPage,
SystemChangeFilterDialog,
SystemChangeFilterPropertyPage,
SystemChangePasswordDialog,
SystemFilterStringPropertyPage,
SystemMessageLine,
SystemNewFilterWizardInfoPage,
SystemNewFilterWizardMainPage,
SystemNewFilterWizardNamePage,
SystemNewProfileWizardMainPage,
SystemPasswordPersistencePrompt,
SystemPasswordPromptDialog,
SystemPromptDialog,
SystemPromptForHomeFolderDialog,
SystemRemoteArchiveDialog,
SystemRemoteFileDialog,
SystemRemoteFolderDialog,
SystemRemoteResourceDialog,
SystemRenameSingleDialog,
SystemSelectAnythingDialog,
SystemSelectFileTypesDialog,
SystemSimpleCopyDialog,
SystemSimpleSelectDialog,
SystemSubSystemPropertyPageCore,
SystemTeamViewCategoryPropertyPage
-
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.
clearErrorMessage
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).
-
clearMessage
void clearMessage()
- Clears the currently displayed message.
-
getErrorMessage
String getErrorMessage()
- Get the currently displayed error text.
-
-
Returns:
- The error message. If no error message is displayed
null is returned.
getSystemErrorMessage
SystemMessage getSystemErrorMessage()
- Get the currently displayed error text.
-
-
Returns:
- The error message. If no error message is displayed
null is returned.
getMessage
String getMessage()
- Get the currently displayed message.
-
-
Returns:
- The message. If no message is displayed
null is returned.
setErrorMessage
void setErrorMessage(
String message)
- Display the given error message. A currently displayed (non-error) message
is saved and will be redisplayed when the error message is cleared.
-
setErrorMessage
void setErrorMessage(
SystemMessage message)
- Display the given error message. A currently displayed (non-error) message
is saved and will be redisplayed when the error message is cleared.
-
setErrorMessage
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
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
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
-
Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.
|
|
|