Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.view
Interface ISystemViewInputProvider

All Superinterfaces:
IAdaptable
All Known Subinterfaces:
SystemFileAPIProvider, SystemRegistry
All Known Implementing Classes:
SystemAbstractAPIProvider, SystemEmptyListAPIProviderImpl, SystemFileAPIProviderImpl, SystemFileSubSystemAPIProviderImpl, SystemFileSubSystemFactoryAPIProviderImpl, SystemRegistryImpl, SystemSelectRemoteObjectAPIProviderImpl, SystemTeamViewInputProvider, SystemTestFilterStringAPIProviderImpl

public interface ISystemViewInputProvider
extends IAdaptable

Abstraction for any object that wishes to be a roots-provider for the SystemView tree viewer.


Field Summary
static String copyright
           
 
Method Summary
 Object getAdapter(Class adapterType)
          This is the method required by the IAdaptable interface.
 Object[] getConnectionChildren(SystemConnection selectedConnection)
          This method is called by the connection adapter when the user expands a connection.
 Shell getShell()
          Return the shell of the viewer we are currently associated with
 Object[] getSystemViewRoots()
          Return the children objects to consistute the root elements in the system view tree
 Viewer getViewer()
          Return the viewer we are currently associated with
 boolean hasConnectionChildren(SystemConnection selectedConnection)
          This method is called by the connection adapter when deciding to show a plus-sign or not beside a connection.
 boolean hasSystemViewRoots()
          Return true if getSystemViewRoots() will return a non-empty list
 void setShell(Shell shell)
          Set the shell in case it is needed for anything.
 void setViewer(Viewer viewer)
          Set the viewer in case it is needed for anything.
 boolean showActionBar()
          Return true to show the action bar (ie, toolbar) above the viewer.
 boolean showActions()
          Return true to show right-click popup actions on objects in the tree.
 boolean showButtonBar()
          Return true to show the button bar above the viewer.
 boolean showingConnections()
          Return true if we are listing connections or not, so we know whether we are interested in connection-add events
 

Field Detail

copyright

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

getSystemViewRoots

public Object[] getSystemViewRoots()
Return the children objects to consistute the root elements in the system view tree


hasSystemViewRoots

public boolean hasSystemViewRoots()
Return true if getSystemViewRoots() will return a non-empty list


showingConnections

public boolean showingConnections()
Return true if we are listing connections or not, so we know whether we are interested in connection-add events


getConnectionChildren

public Object[] getConnectionChildren(SystemConnection selectedConnection)
This method is called by the connection adapter when the user expands a connection. This method must return the child objects to show for that connection.


hasConnectionChildren

public boolean hasConnectionChildren(SystemConnection selectedConnection)
This method is called by the connection adapter when deciding to show a plus-sign or not beside a connection. Return true if this connection has children to be shown.


getAdapter

public Object getAdapter(Class adapterType)
This is the method required by the IAdaptable interface. Given an adapter class type, return an object castable to the type, or null if this is not possible.

Specified by:
getAdapter in interface IAdaptable

setShell

public void setShell(Shell shell)
Set the shell in case it is needed for anything. The label and content provider will call this.


getShell

public Shell getShell()
Return the shell of the viewer we are currently associated with


setViewer

public void setViewer(Viewer viewer)
Set the viewer in case it is needed for anything. The label and content provider will call this.


getViewer

public Viewer getViewer()
Return the viewer we are currently associated with


showActionBar

public boolean showActionBar()
Return true to show the action bar (ie, toolbar) above the viewer. The action bar contains connection actions, predominantly.


showButtonBar

public boolean showButtonBar()
Return true to show the button bar above the viewer. The tool bar contains "Get List" and "Refresh" buttons and is typicall shown in dialogs that list only remote system objects.


showActions

public boolean showActions()
Return true to show right-click popup actions on objects in the tree.


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.