org.eclipse.rse.ui.view
Interface ISystemViewInputProvider

All Superinterfaces:

IAdaptable

All Known Subinterfaces:

ISystemFileAPIProvider

All Known Implementing Classes:

SystemAbstractAPIProvider, SystemEmptyListAPIProviderImpl, SystemRegistry, SystemSelectRemoteObjectAPIProviderImpl, SystemTeamViewInputProvider, SystemTestFilterStringAPIProviderImpl

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.
Shell	getShell()
Object[]	getSystemViewRoots()
Viewer	getViewer()
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(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()
boolean	showActions()
boolean	showButtonBar()
boolean	showingConnections()

Method Detail

getSystemViewRoots

public Object[] getSystemViewRoots()

Returns:

the children objects to consistute the root elements in the system view tree

hasSystemViewRoots

public boolean hasSystemViewRoots()

Returns:

true if getSystemViewRoots() will return a non-empty list

showingConnections

public boolean showingConnections()

Returns:

true if we are listing connections or not, so we know whether we are interested in connection-add events

getConnectionChildren

public 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

public 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

public Object getAdapter(Class adapterType)

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.

Parameters:

shell - the shell being used by the viewer using this provider

getShell

public Shell getShell()

Returns:

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.

Parameters:

viewer - the viewer that uses this provider

getViewer

public Viewer getViewer()

Returns:

the viewer we are currently associated with

showActionBar

public boolean showActionBar()

Returns:

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

showButtonBar

public boolean showButtonBar()

Returns:

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()

Returns:

true to show right-click popup actions on objects in the tree.