Remote Systems
v6.4.1

com.ibm.etools.systems.model
Interface ISystemPromptableObject

All Superinterfaces:
IAdaptable
All Known Implementing Classes:
SystemNewConnectionPromptObject

public interface ISystemPromptableObject
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 com.ibm.etools.systems.core.ui.view.SystemViewPromptableAdapter


Field Summary
static String copyright
           
 
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)
 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
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

getParent

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


setParent

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


getImageDescriptor

public ImageDescriptor getImageDescriptor()
Returns an image descriptor for the image. More efficient than getting the image. Calls getImage on the subsystem's owning factory.


getText

public String getText()
Return the label for this object


getType

public String getType()
Return the type label for this object


run

public 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

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


hasChildren

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


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.