RSE
Release 1.0

org.eclipse.rse.ui.view
Class SystemViewAPIProviderForFilterStrings

java.lang.Object
  extended byorg.eclipse.rse.ui.view.SystemAbstractAPIProvider
      extended byorg.eclipse.rse.ui.view.SystemViewAPIProviderForFilterStrings
All Implemented Interfaces:
IAdaptable, ISystemViewInputProvider

public class SystemViewAPIProviderForFilterStrings
extends SystemAbstractAPIProvider

This class is a provider of root nodes to the remote systems tree viewer part. It is used when the contents are the children of a particular subsystem. Used when user right clicks on a filter string and selects Open In New Perspective.


Field Summary
protected  ISystemFilter filter
           
protected  ISystemFilterPool filterPool
           
protected  ISystemFilterPoolReference filterPoolReference
           
protected  ISystemFilterReference filterReference
           
protected  ISystemFilterString filterString
           
protected  ISystemFilterStringReference filterStringReference
           
protected  ISubSystem subsystem
           
 
Fields inherited from class org.eclipse.rse.ui.view.SystemAbstractAPIProvider
canceledObject, emptyList, errorObject, msgList, nullObject, shell, sr, viewer
 
Constructor Summary
SystemViewAPIProviderForFilterStrings(ISystemFilterStringReference filterStringReference)
          Constructor
 
Method Summary
 Object[] getConnectionChildren(IHost selectedConnection)
          This method is called by the connection adapter when the user expands a connection.
 ISubSystem getSubSystem()
          Get the parent subsystem object.
 ISystemFilter getSystemFilter()
          Get the parent filter
 ISystemFilterPool getSystemFilterPool()
          Get the parent filter pool.
 ISystemFilterPoolReference getSystemFilterPoolReference()
          Get the parent filter pool reference object.
 ISystemFilterReference getSystemFilterReference()
          Get the parent filter reference object.
 ISystemFilterString getSystemFilterString()
          Get the filter referenced by the input filter string reference object.
 ISystemFilterStringReference getSystemFilterStringReference()
          Get the input filter string reference object.
 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
 void setFilterStringReference(ISystemFilterStringReference filterStringReference)
          Reset the input filter string reference object.
 boolean showActions()
          Return true to show right-click popup actions on objects in the tree.
 
Methods inherited from class org.eclipse.rse.ui.view.SystemAbstractAPIProvider
checkForNull, getAdapter, getAdapter, getCancelledMessageObject, getFailedMessageObject, getRemoteAdapter, getShell, getViewer, setShell, setViewer, showActionBar, showButtonBar, showingConnections
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

subsystem

protected ISubSystem subsystem

filterPool

protected ISystemFilterPool filterPool

filterPoolReference

protected ISystemFilterPoolReference filterPoolReference

filterReference

protected ISystemFilterReference filterReference

filter

protected ISystemFilter filter

filterString

protected ISystemFilterString filterString

filterStringReference

protected ISystemFilterStringReference filterStringReference
Constructor Detail

SystemViewAPIProviderForFilterStrings

public SystemViewAPIProviderForFilterStrings(ISystemFilterStringReference filterStringReference)
Constructor

Parameters:
filterStringReference - The filter string reference object we are drilling down on.
Method Detail

getSubSystem

public ISubSystem getSubSystem()
Get the parent subsystem object.


getSystemFilterPoolReference

public ISystemFilterPoolReference getSystemFilterPoolReference()
Get the parent filter pool reference object.


getSystemFilterPool

public ISystemFilterPool getSystemFilterPool()
Get the parent filter pool.


getSystemFilterReference

public ISystemFilterReference getSystemFilterReference()
Get the parent filter reference object.


getSystemFilter

public ISystemFilter getSystemFilter()
Get the parent filter


getSystemFilterStringReference

public ISystemFilterStringReference getSystemFilterStringReference()
Get the input filter string reference object.


getSystemFilterString

public ISystemFilterString getSystemFilterString()
Get the filter referenced by the input filter string reference object.


setFilterStringReference

public void setFilterStringReference(ISystemFilterStringReference filterStringReference)
Reset the input filter string reference object.


getSystemViewRoots

public Object[] getSystemViewRoots()
Return the children objects to consistute the root elements in the system view tree. What we return depends on setting of Show Filter Strings.

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

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 for us.

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 for us.

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

showActions

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

Specified by:
showActions in interface ISystemViewInputProvider
Overrides:
showActions in class SystemAbstractAPIProvider

RSE
Release 1.0

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