Eclipse Plug-in Developer Guide (Galileo) - IMessageProvider (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.dialogs
Interface IMessageProvider

All Known Subinterfaces:: IMessage

All Known Implementing Classes:: ActivitiesPreferencePage, ActivityCategoryPreferencePage, DialogPage, FieldEditorPreferencePage, InstallationPage, PreferencePage, PropertyPage, RefactoringWizardPage, RootScopePage, TemplatePreferencePage, TextEditorPreferencePage, UserInputWizardPage, WizardDataTransferPage, WizardExportPage, WizardExportResourcesPage, WizardExternalProjectImportPage, WizardImportPage, 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

static int ERROR
          Constant for an error message (value 3).

static int INFORMATION
          Constant for an info message (value 1).

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

static int WARNING
          Constant for a warning message (value 2).

Method Summary

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 Detail

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:: Constant Field Values

INFORMATION

static final int INFORMATION

Constant for an info message (value 1).

See Also:: Constant Field Values

WARNING

static final int WARNING

Constant for a warning message (value 2).

See Also:: Constant Field Values

ERROR

static final int ERROR

Constant for an error message (value 3).

See Also:: Constant Field Values

Method Detail

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