Package org.eclipse.ui.forms
Interface IMessage
-
- All Superinterfaces:
IMessageProvider
public interface IMessage extends IMessageProvider
This interface encapsulates a single message that can be shown in a form. Messages can be associated with controls, or be of a general nature.- Since:
- 3.3
- See Also:
IMessageManager
-
-
Field Summary
-
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Control
getControl()
Returns the control this message is associated with.Object
getData()
Returns data for application useObject
getKey()
Returns the unique message keyString
getPrefix()
Messages that are associated with controls can be shown with a prefix that indicates the origin of the message (e.g. the label preceeding the control).-
Methods inherited from interface org.eclipse.jface.dialogs.IMessageProvider
getMessage, getMessageType
-
-
-
-
Method Detail
-
getKey
Object getKey()
Returns the unique message key- Returns:
- the unique message key
-
getData
Object getData()
Returns data for application use- Returns:
- data object
-
getControl
Control getControl()
Returns the control this message is associated with.- Returns:
- the control or
null
if this is a general message.
-
getPrefix
String getPrefix()
Messages that are associated with controls can be shown with a prefix that indicates the origin of the message (e.g. the label preceeding the control).- Returns:
- the message prefix or
null
if this is a general message
-
-