Eclipse RSE Development Guide (Galileo) - ISystemMessageObject (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core.model
Interface ISystemMessageObject

All Known Implementing Classes:: SystemMessageObject

public interface ISystemMessageObject

This interface represents a message we wish to display as child node in the tree view.

Field Summary

static int MSGTYPE_CANCEL
          1.

static int MSGTYPE_EMPTY
          4.

static int MSGTYPE_ERROR
          0.

static int MSGTYPE_INFO
          3.

static int MSGTYPE_OBJECTCREATED
          5.

Method Summary

String getMessage ()
          Return the message text shown for the label.

Object getParent ()
          Return the parent object in the tree.

int getType ()
          Return the type of message: MSGTYPE_ERROR MSGTYPE_CANCEL MSGTYPE_INFO MSGTYPE_EMPTY MSGTYPE_OBJECTCREATED

boolean isTransient ()
          isTransient determines if the message should be removed from the tree when the parent item in the tree is collapsed.

Field Detail

MSGTYPE_ERROR

static final int MSGTYPE_ERROR

0. An error occurred.

See Also:: Constant Field Values

MSGTYPE_CANCEL

static final int MSGTYPE_CANCEL

1. User cancelled

See Also:: Constant Field Values

MSGTYPE_INFO

static final int MSGTYPE_INFO

3. Informational text

See Also:: Constant Field Values

MSGTYPE_EMPTY

static final int MSGTYPE_EMPTY

4. Empty list. Eg "Nothing meets subset criteria"

See Also:: Constant Field Values

MSGTYPE_OBJECTCREATED

static final int MSGTYPE_OBJECTCREATED

5. Object created successfully.

See Also:: Constant Field Values

Method Detail

getMessage


String getMessage()

Return the message text shown for the label. The translated text is pre-determined from the message type.

getType

int getType()

Return the type of message:

getParent


Object getParent()

Return the parent object in the tree. That is, what was expanded to produce this message

isTransient

boolean isTransient()

isTransient determines if the message should be removed from the tree when the parent item in the tree is collapsed.

Returns:: true if the item should be removed, false if it should not