org.eclipse.rse.ui.view
Class SystemTestFilterStringAPIProviderImpl

java.lang.Object
  org.eclipse.rse.ui.view.SystemAbstractAPIProvider
      org.eclipse.rse.ui.view.SystemTestFilterStringAPIProviderImpl

All Implemented Interfaces:

IAdaptable, ISystemViewInputProvider

Direct Known Subclasses:

SystemResolveFilterStringAPIProviderImpl

public class SystemTestFilterStringAPIProviderImpl

extends SystemAbstractAPIProvider

implements ISystemViewInputProvider

This class is a provider of root nodes to the remote systems tree viewer part. It is used when the contents are used to show the resolution of a single filter string.

Field Summary

protected SystemMessageObject	canceledObject
protected Object[]	emptyList
protected SystemMessageObject	errorObject
protected String	filterString
protected Object[]	msgList
protected SystemMessageObject	nullObject
protected ISubSystem	subsystem

Fields inherited from class org.eclipse.rse.ui.view.SystemAbstractAPIProvider

shell, sr, viewer

Constructor Summary

SystemTestFilterStringAPIProviderImpl(ISubSystem subsystem, String filterString)
Constructor

Method Summary

Object[]	getConnectionChildren(IHost selectedConnection) This method is called by the connection adapter when the user expands a connection.
Object[]	getSystemViewRoots() Return the children objects to consistute the root elements in the system view tree.
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() Return true if getSystemViewRoots() will return a non-empty list We return true on the assumption the filter string will resolve to something.
void	setFilterString(String filterString) Change the input filter string
void	setSubSystem(ISubSystem subsystem) Change the input subsystem
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.

Methods inherited from class org.eclipse.rse.ui.view.SystemAbstractAPIProvider

checkForNull, getAdapter, getAdapter, getCancelledMessageObject, getFailedMessageObject, getRemoteAdapter, getShell, getViewer, setShell, setViewer, showingConnections

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.rse.ui.view.ISystemViewInputProvider

getAdapter, getShell, getViewer, setShell, setViewer, showingConnections

Field Detail

filterString

protected String filterString

subsystem

protected ISubSystem subsystem

emptyList

protected Object[] emptyList

msgList

protected Object[] msgList

nullObject

protected SystemMessageObject nullObject

canceledObject

protected SystemMessageObject canceledObject

errorObject

protected SystemMessageObject errorObject

Constructor Detail

SystemTestFilterStringAPIProviderImpl

public SystemTestFilterStringAPIProviderImpl(ISubSystem subsystem,
                                             String filterString)

Constructor

Parameters:

subsystem - The subsystem that will resolve the filter string

filterString - The filter string to test

Method Detail

setSubSystem

public void setSubSystem(ISubSystem subsystem)

Change the input subsystem

setFilterString

public void setFilterString(String filterString)

Change the input filter string

getSystemViewRoots

public Object[] getSystemViewRoots()

Return the children objects to consistute the root elements in the system view tree. We return the result of asking the subsystem to resolve the filter string.

Specified by:

getSystemViewRoots in interface ISystemViewInputProvider

Returns:

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 We return true on the assumption the filter string will resolve to something.

Specified by:

hasSystemViewRoots in interface ISystemViewInputProvider

Returns:

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

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.

NOT APPLICABLE TO US

Specified by:

getConnectionChildren in interface ISystemViewInputProvider

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. Return true if this connection has children to be shown.

NOT APPLICABLE TO US

Specified by:

hasConnectionChildren in interface ISystemViewInputProvider

Parameters:

selectedConnection - the connection being shown in the viewer

Returns:

true if this connection has children to be shown.

showActionBar

public boolean showActionBar()

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

Specified by:

showActionBar in interface ISystemViewInputProvider

Overrides:

showActionBar in class SystemAbstractAPIProvider

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.

Specified by:

showButtonBar in interface ISystemViewInputProvider

Overrides:

showButtonBar in class SystemAbstractAPIProvider

showActions

public boolean showActions()

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

Specified by:

showActions in interface ISystemViewInputProvider

Overrides:

showActions in class SystemAbstractAPIProvider