Eclipse RSE Development Guide (Galileo) - ISystemPromptableObject (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.ui.model
Interface ISystemPromptableObject

All Superinterfaces:: IAdaptable

public interface ISystemPromptableObject
extends IAdaptable
extends IAdaptable

This interface captures special-case objects in the SystemView that are only there to prompt the user to create something new. Eg "New Connection..." which when selected launches the new connection wizard.

These promptables can either run when expanded, or they can show child promptable objects

Related adapter is org.eclipse.rse.ui.view.SystemViewPromptableAdapter

Method Summary

ISystemPromptableObject[] getChildren ()
          Return the child promptable objects.

ImageDescriptor getImageDescriptor ()
          Returns an image descriptor for the image.

Object getParent ()
          Get the parent object (within tree view)

IRSESystemType[] getSystemTypes ()
          Returns the list of system types this promptable object is associated with.

String getText ()
          Return the label for this object

String getType ()
          Return the type label for this object

boolean hasChildren ()
          Return true if this is an expandable prompt

Object[] run ( Shell shell)
          Run this prompt.

void setParent ( Object parent)
          Set the parent object so that we can respond to getParent requests

Methods inherited from interface org.eclipse.core.runtime. IAdaptable

getAdapter

Method Detail

getSystemTypes


IRSESystemType[] getSystemTypes()

Returns the list of system types this promptable object is associated with. This is important to implement label and icon decorators for promptable objects.

Returns:: The list of associated system types or an empty list.

getParent


Object getParent()

Get the parent object (within tree view)

setParent

void setParent(
Object parent)

Set the parent object so that we can respond to getParent requests

getImageDescriptor


ImageDescriptor getImageDescriptor()

Returns an image descriptor for the image. More efficient than getting the image. Calls getImage on the subsystem's owning factory.

getText


String getText()

Return the label for this object

getType


String getType()

Return the type label for this object

run


Object[] run(
Shell shell)

Run this prompt. This should return an appropriate ISystemMessageObject to show as the child, reflecting if it ran successfully, was cancelled or failed.

getChildren


ISystemPromptableObject[] getChildren()

Return the child promptable objects. If this returns null, then SystemViewPromptableAdapter will subsequently call run(Shell).

hasChildren

boolean hasChildren()

Return true if this is an expandable prompt