RSE
Release 2.0

org.eclipse.rse.core.model
Interface ISystemViewInputProvider

All Superinterfaces:
IAdaptable
All Known Subinterfaces:
ISystemFileAPIProvider, ISystemRegistry
All Known Implementing Classes:
org.eclipse.rse.internal.ui.view.SystemAbstractAPIProvider, SystemRemoteFileSelectionInputProvider, org.eclipse.rse.internal.ui.view.SystemResourceSelectionInputProvider

public interface ISystemViewInputProvider
extends IAdaptable

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


Method Summary
 Object getAdapter(Class adapterType)
           
 Object[] getConnectionChildren(IHost selectedConnection)
          This method is called by the connection adapter when the user expands a connection.
 Object getShell()
          Deprecated. use other methods for getting the active workbench shell, e.g. SystemBasePlugin.getActiveWorkbenchShell()
 Object[] getSystemViewRoots()
           
 Object getViewer()
          Deprecated. use other methods for getting the active viewer.
 boolean hasConnectionChildren(IHost selectedConnection)
          This method is called by the connection adapter when deciding to show a plus-sign or not beside a connection.
 boolean hasSystemViewRoots()
           
 void setShell(Object shell)
          Set the shell in case it is needed for anything.
 void setViewer(Object viewer)
          Set the viewer in case it is needed for anything.
 boolean showingConnections()
           
 

Method Detail

getSystemViewRoots

Object[] getSystemViewRoots()
Returns:
the children objects to constitute the root elements in the system view tree

hasSystemViewRoots

boolean hasSystemViewRoots()
Returns:
true if getSystemViewRoots() will return a non-empty list

showingConnections

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

getConnectionChildren

Object[] getConnectionChildren(IHost 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.

Parameters:
selectedConnection - the connection undergoing expansion
Returns:
the list of objects under the connection

hasConnectionChildren

boolean hasConnectionChildren(IHost selectedConnection)
This method is called by the connection adapter when deciding to show a plus-sign or not beside a connection.

Parameters:
selectedConnection - the connection being shown in the viewer
Returns:
true if this connection has children to be shown.

getAdapter

Object getAdapter(Class adapterType)
Specified by:
getAdapter in interface IAdaptable

setShell

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

Parameters:
shell - an shell object, being used by the viewer using this provider

getShell

Object getShell()
Deprecated. use other methods for getting the active workbench shell, e.g. SystemBasePlugin.getActiveWorkbenchShell()

Returns:
the shell of the viewer we are currently associated with.

setViewer

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

Parameters:
viewer - the viewer that uses this provider

getViewer

Object getViewer()
Deprecated. use other methods for getting the active viewer.

Return the viewer we are currently associated with

Returns:
the viewer we are currently associated with

RSE
Release 2.0

Copyright (c) IBM Corporation and others 2000, 2007. All Rights Reserved.