Interface IMessageProvider

All Known Subinterfaces:
IMessage
All Known Implementing Classes:
AcceptLicensesWizardPage, ActivitiesPreferencePage, ActivityCategoryPreferencePage, ComparePreferencePage, DialogPage, FieldEditorPreferencePage, InstallationPage, InstalledSoftwarePage, PreferencePage, PropertyPage, RefactoringWizardPage, RenameResourceWizard.RenameResourceRefactoringConfigurationPage, RepositoryManipulationPage, RevertProfilePage, RootScopePage, TemplatePreferencePage, TextEditorPreferencePage, UserInputWizardPage, WizardDataTransferPage, WizardExportResourcesPage, WizardExternalProjectImportPage, WizardNewFileCreationPage, WizardNewFolderMainPage, WizardNewLinkPage, WizardNewProjectCreationPage, WizardNewProjectReferencePage, WizardPage, WizardPropertyPage, WizardResourceImportPage, WizardSelectionPage
public interface IMessageProvider
Minimal interface to a message provider. Used for dialog pages which can provide a message with an icon.
Since:
2.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ERROR
    Constant for an error message (value 3).
    static final int
    INFORMATION
    Constant for an info message (value 1).
    static final int
    NONE
    Constant for a regular message (value 0).
    static final int
    WARNING
    Constant for a warning message (value 2).

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMessage()
    Returns the current message for this message provider.
    int
    getMessageType()
    Returns a value indicating if the message is a an information message, a warning message, or an error message.

  • Field Details

    • NONE

      static final int NONE
      Constant for a regular message (value 0).

      Typically this indicates that the message should be shown without an icon.

      See Also:

    • INFORMATION

      static final int INFORMATION
      Constant for an info message (value 1).
      See Also:

    • WARNING

      static final int WARNING
      Constant for a warning message (value 2).
      See Also:

    • ERROR

      static final int ERROR
      Constant for an error message (value 3).
      See Also:

  • Method Details

    • getMessage

      String getMessage()
      Returns the current message for this message provider.

      A message provides instruction or information to the user.

      Returns:
      the message, or null if none

    • getMessageType

      int getMessageType()
      Returns a value indicating if the message is a an information message, a warning message, or an error message.

      Returns one of NONE,INFORMATION, WARNING, or ERROR.

      Returns:
      the message type