Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.ui.view
Class SubSystemConfigurationAdapter

java.lang.Object
  extended by 
org.eclipse.rse.ui.view.SubSystemConfigurationAdapter
All Implemented Interfaces:
ISystemNewFilterActionConfigurator, ISubSystemConfigurationAdapter

public class SubSystemConfigurationAdapter
extends Object
implements ISubSystemConfigurationAdapter, ISystemNewFilterActionConfigurator


Field Summary
protected   Hashtable imageTable
           
 
Constructor Summary
SubSystemConfigurationAdapter ()
           
 
Method Summary
 void addCommonRemoteActions ( ISubSystemConfiguration config, SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystem subsystem)
          Returns any framework-supplied actions remote objects that should be contributed to the popup menu for the given selection list.
protected  void addConnectOrDisconnectAction ( Vector actions, Shell shell, ISubSystem selectedSS)
          Overridable method to add the connect or disconnect action.
  Object[] applyViewFilters ( IContextObject parent, Object[] children)
          The default implementation does not filter and simply returns the children passed in.
 void configureNewFilterAction ( ISubSystemConfiguration config, SystemNewFilterAction newFilterAction, Object callerData)
          There is a reasonable amount of processing needed to configure filter wizards.
  ISystemFilter createFilterByPrompting ( ISubSystemConfiguration config, ISystemFilterReference referenceToPromptableFilter, Shell shell)
          Prompt the user to create a new filter as a result of the user expanding a promptable filter.
 void customizeChangeFilterPropertyPage ( ISubSystemConfiguration config, SystemChangeFilterPropertyPage page, ISystemFilter selectedFilter, Shell shell)
          In addition to a change filter action, we now also support the same functionality via a Properties page for filters.
 void customizeFilterStringPropertyPage ( ISubSystemConfiguration config, SystemFilterStringPropertyPage page, ISystemFilterString selectedFilterString, Shell shell)
          In addition to a change filter action, we now also support the same functionality via a Properties page for filter strings, in the Team View.
protected   Vector getAdditionalFilterActions ( ISubSystemConfiguration config, ISystemFilter selectedFilter, Shell shell)
          Overridable entry for child classes to contribute filter actions beyond the default supplied actions.
protected   IAction getChangeFilterAction ( ISubSystemConfiguration config, ISystemFilter selectedFilter, Shell shell)
          Overridable method to return the action for changing an existing filter.
  ISystemFilterPool getDefaultSystemFilterPool ( ISubSystemConfiguration config, ISystemProfile profile)
          Given a profile, return the first (hopefully only) default pool for this profile.
  IAction[] getFilterActions ( SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilter selectedFilter)
          Returns a list of actions for the popup menu when user right clicks on a filter object.
  IAction[] getFilterPoolActions ( SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterPool selectedPool)
          Returns a list of actions for the popup menu when user right clicks on a filter pool object within a subsystem of this subsystem configuration.
  IAction[] getFilterPoolReferenceActions ( SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterPoolReference selectedPoolReference)
          Returns a list of actions for the popup menu when user right clicks on a filter pool reference object within a subsystem of this subsystem configuration.
  IAction[] getFilterReferenceActions ( SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterReference selectedFilterRef)
          Returns a list of actions for the popup menu when user right clicks on a filter reference object within a subsystem of this subsystem configuration.
  Image getGraphicsImage ( ISubSystemConfiguration config)
          Return actual graphics Image of this subsystem configuration.
  Image getGraphicsLiveImage ( ISubSystemConfiguration config)
          Return actual graphics LiveImage of this subsystem configuration.
  ImageDescriptor getImage ( ISubSystemConfiguration config)
          Return image descriptor for subsystems created by this subsystem configuration.
  ImageDescriptor getLiveImage ( ISubSystemConfiguration config)
          Return image to use when this subsystem is connected.
 org.eclipse.rse.ui.wizards.newconnection.ISystemNewConnectionWizardPage[] getNewConnectionWizardPages ( ISubSystemConfiguration config, IWizard wizard)
          Optionally return one or more wizard pages to append to the New Wizard connection if the user selects a system type that this subsystem configuration supports.
protected   IAction getNewFilterPoolFilterAction ( ISubSystemConfiguration config, ISystemFilterPool selectedPool, Shell shell)
          Overridable method to return the single action for creating a new filter in a filter pool.
protected   IAction[] getNewFilterPoolFilterActions ( SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterPool selectedPool)
          Overridable method to return the actions for creating a new filter in a filter pool.
protected   ISystemFilterPoolWrapperInformation getNewFilterWizardPoolWrapperInformation ()
          Overridable entry for child classes to supply their own flavour of ISystemFilterPoolWrapperInformation for the new filter wizards.
protected   IAction getNewNestedFilterAction ( ISubSystemConfiguration config, ISystemFilter selectedFilter, Shell shell)
          Overridable method to return the action for creating a new nested filter inside another filter.
  ISystemValidator getPasswordValidator ( ISubSystemConfiguration configuration)
          Return the validator for the password which is prompted for at runtime.
  ISystemValidator getPortValidator ( ISubSystemConfiguration configuration)
          Return the validator for the port.
  PropertyPage getPropertyPage ( ISubSystem subsystem, Composite parent)
          Return the single property page to show in the tabbed notebook for the for SubSystem property of the parent Connection.
protected   IAction getRemoveFilterPoolReferenceAction ( ISubSystemConfiguration config, ISystemFilterPool selectedPool, Shell shell)
          Overridable method to return the action for removing a filter pool reference.
  IServerLauncherForm getServerLauncherForm ( ISubSystemConfiguration config, Shell shell, ISystemMessageLine msgLine)
          Return the form used in the property page, etc for this server launcher.
  IAction[] getSubSystemActions ( SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISubSystem selectedSubSystem)
          Returns a list of actions for the popup menu when user right clicks on a subsystem object from this subsystem configuration.
protected   IAction[] getSubSystemNewFilterPoolActions ( SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISubSystem selectedSubSystem)
          Overridable entry for child classes to supply their own "new" action(s) for creating a filter pool.
  ISystemSubSystemPropertyPageCoreForm getSubSystemPropertyPageCoreFrom ( ISubSystemConfiguration config, ISystemMessageLine msgLine, Object caller)
          Return the form used in the subsystem property page.
  ImageDescriptor getSystemFilterImage ( ISystemFilter filter)
          Supply the image to be used for filters, within actions.
  ImageDescriptor getSystemFilterImage ( ISystemFilterReference filterRef)
          Supply the image to be used for filter references.
  ImageDescriptor getSystemFilterPoolImage ( ISystemFilterPool filterPool)
          Supply the image to be used for filter pools, within actions.
  ImageDescriptor getSystemFilterPoolImage ( ISystemFilterPoolReference filterPoolRef)
          Supply the image to be used for filter pool references.
  ImageDescriptor getSystemFilterPoolManagerImage ()
          Supply the image to be used for filter pool managers, within actions.
  ImageDescriptor getSystemFilterStringImage ( ISystemFilterString filterString)
          Supply the image to be used for the given filter string, within actions.
  ImageDescriptor getSystemFilterStringImage ( String filterStringString)
          Supply the image to be used for the given filter string string, within actions.
  ISystemValidator getUserIdValidator ( ISubSystemConfiguration config)
          Return the validator for the userId.
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

imageTable

protected 
Hashtable imageTable
Constructor Detail

SubSystemConfigurationAdapter

public SubSystemConfigurationAdapter()
Method Detail

addCommonRemoteActions

public void addCommonRemoteActions(
ISubSystemConfiguration config,
                                   
SystemMenuManager menu,
                                   
IStructuredSelection selection,
                                   
Shell shell,
                                   
String menuGroup,
                                   
ISubSystem subsystem)
Returns any framework-supplied actions remote objects that should be contributed to the popup menu for the given selection list. This does nothing if this adapter does not implement ISystemRemoteElementAdapter, else it potentially adds menu items for "User Actions" and Compile", for example. It queries the subsystem configuration of the selected objects to determine if these actions are appropriate to add.

No need to override.

Specified by:
addCommonRemoteActions in interface ISubSystemConfigurationAdapter
Parameters:
menu - The menu to contribute actions to
selection - The window's current selection.
shell - of viewer calling this. Most dialogs require a shell.
menuGroup - recommended menu group to add actions to. If added to another group, you must be sure to create that group first.
subsystem - the subsystem of the selection
config - The subsystem configuration to work on

getNewConnectionWizardPages

public org.eclipse.rse.ui.wizards.newconnection.ISystemNewConnectionWizardPage[] getNewConnectionWizardPages(
ISubSystemConfiguration config,
                                                                                                             
IWizard wizard)
Optionally return one or more wizard pages to append to the New Wizard connection if the user selects a system type that this subsystem configuration supports.

Some details:

  • The wizard pages must implement ISystemNewConnectionWizardPage, so as to fit into the wizard's framework
  • When the user successfully presses Finish, the createConnection method in the SystemRegistry will call your SubSystemConfiguration.createSubSystem(org.eclipse.rse.core.model.IHost,boolean, ISubSystemConfigurator[]) method to create the your subsystem for the connection. The same pages you return here are passed back to you so you can interrogate them for the user-entered data and use it when creating the default subsystem instance.
Tip: consider extending AbstractSystemNewConnectionWizardPage for your wizard page class.

Specified by:
getNewConnectionWizardPages in interface ISubSystemConfigurationAdapter
Since:
3.0 ISystemNewConnectionWizardPage moved from Core to UI

getSubSystemPropertyPageCoreFrom

public 
ISystemSubSystemPropertyPageCoreForm getSubSystemPropertyPageCoreFrom(
ISubSystemConfiguration config,
                                                                             
ISystemMessageLine msgLine,
                                                                             
Object caller)
Description copied from interface: ISubSystemConfigurationAdapter
Return the form used in the subsystem property page.

Specified by:
getSubSystemPropertyPageCoreFrom in interface ISubSystemConfigurationAdapter
Returns:
the form used in the subsystem property page.

getImage

public 
ImageDescriptor getImage(
ISubSystemConfiguration config)
Description copied from interface: ISubSystemConfigurationAdapter
Return image descriptor for subsystems created by this subsystem configuration. Comes from icon attribute in extension point xml.

Specified by:
getImage in interface ISubSystemConfigurationAdapter
Parameters:
config - the subsystem configuration
Returns:
the image descriptor for the given subsystem configuration.

getGraphicsImage

public 
Image getGraphicsImage(
ISubSystemConfiguration config)
Description copied from interface: ISubSystemConfigurationAdapter
Return actual graphics Image of this subsystem configuration. This is the same as calling getImage().createImage(), but the resulting image is cached.

Specified by:
getGraphicsImage in interface ISubSystemConfigurationAdapter
Parameters:
config - the subsystem configuration
Returns:
the cached image for the given subsystem configuration.

getLiveImage

public 
ImageDescriptor getLiveImage(
ISubSystemConfiguration config)
Description copied from interface: ISubSystemConfigurationAdapter
Return image to use when this subsystem is connected. Comes from icon attribute in extension point xml.

Specified by:
getLiveImage in interface ISubSystemConfigurationAdapter
Parameters:
config - the subsystem configuration
Returns:
the image descriptor for the given subsystem configuration.

getGraphicsLiveImage

public 
Image getGraphicsLiveImage(
ISubSystemConfiguration config)
Description copied from interface: ISubSystemConfigurationAdapter
Return actual graphics LiveImage of this subsystem configuration. This is the same as calling getLiveImage().createImage(), but the resulting image is cached.

Specified by:
getGraphicsLiveImage in interface ISubSystemConfigurationAdapter
Parameters:
config - the subsystem configuration
Returns:
the cached image for the given subsystem configuration.

getSubSystemActions

public 
IAction[] getSubSystemActions(
SystemMenuManager menu,
                                     
IStructuredSelection selection,
                                     
Shell shell,
                                     
String menuGroup,
                                     
ISubSystemConfiguration config,
                                     
ISubSystem selectedSubSystem)
Returns a list of actions for the popup menu when user right clicks on a subsystem object from this subsystem configuration.

Override if additional actions needs to be contributed.

Specified by:
getSubSystemActions in interface ISubSystemConfigurationAdapter
Parameters:
selectedSubSystem - the currently selected subsystem
shell - The Shell of the view where this action was launched from
Returns:
array of IAction objects to contribute to the popup menu
See Also:
getSubSystemNewFilterPoolActions(SystemMenuManager, IStructuredSelection, Shell, String, ISubSystemConfiguration, ISubSystem)

addConnectOrDisconnectAction

protected void addConnectOrDisconnectAction(
Vector actions,
                                            
Shell shell,
                                            
ISubSystem selectedSS)
Overridable method to add the connect or disconnect action.

Parameters:
actions - The list of child actions. Add the connect/disconnect action to this vector is applicable.
shell - The shell.
selectedSS - The selected subsystem.

configureNewFilterAction

public void configureNewFilterAction(
ISubSystemConfiguration config,
                                     
SystemNewFilterAction newFilterAction,
                                     
Object callerData)
There is a reasonable amount of processing needed to configure filter wizards. To aid in performance and memory usage, we extract that processing into this method, and then use a callback contract with the filter wizard to call us back to do this processing only at the time the action is actually selected to be run.

The processing we do here is to specify the filter pools to prompt the user for, in the second page of the New Filter wizards.

This method is from the ISystemNewFilterActionConfigurator interface

Specified by:
configureNewFilterAction in interface ISystemNewFilterActionConfigurator
Specified by:
configureNewFilterAction in interface ISubSystemConfigurationAdapter
newFilterAction - - the action to be configured
callerData - - context data that you supplied when registering this callback

getDefaultSystemFilterPool

public 
ISystemFilterPool getDefaultSystemFilterPool(
ISubSystemConfiguration config,
                                                    
ISystemProfile profile)
Given a profile, return the first (hopefully only) default pool for this profile.


getNewFilterWizardPoolWrapperInformation

protected 
ISystemFilterPoolWrapperInformation getNewFilterWizardPoolWrapperInformation()
Overridable entry for child classes to supply their own flavour of ISystemFilterPoolWrapperInformation for the new filter wizards.

Since:
3.0 replaced SystemFilterPoolWrapperInformation by ISystemFilterPoolWrapperInformation

getSubSystemNewFilterPoolActions

protected 
IAction[] getSubSystemNewFilterPoolActions(
SystemMenuManager menu,
                                                     
IStructuredSelection selection,
                                                     
Shell shell,
                                                     
String menuGroup,
                                                     
ISubSystemConfiguration config,
                                                     
ISubSystem selectedSubSystem)
Overridable entry for child classes to supply their own "new" action(s) for creating a filter pool. By default, this creates an action for creating a new filter pool and a new filter pool reference.

Parameters:
selectedSubSystem - the currently selected subsystem
shell - The Shell of the view where this action was launched from
Returns:
array of IAction objects to contribute to the popup menu

getSystemFilterPoolManagerImage

public 
ImageDescriptor getSystemFilterPoolManagerImage()
Supply the image to be used for filter pool managers, within actions. REQUIRED BY SYSTEMFILTERPOOLMANAGERPROVIDER INTERFACE

Specified by:
getSystemFilterPoolManagerImage in interface ISubSystemConfigurationAdapter

getSystemFilterPoolImage

public 
ImageDescriptor getSystemFilterPoolImage(
ISystemFilterPool filterPool)
Supply the image to be used for filter pools, within actions. REQUIRED BY SYSTEMFILTERPOOLMANAGERPROVIDER INTERFACE

Specified by:
getSystemFilterPoolImage in interface ISubSystemConfigurationAdapter

getSystemFilterImage

public 
ImageDescriptor getSystemFilterImage(
ISystemFilter filter)
Supply the image to be used for filters, within actions. REQUIRED BY SYSTEMFILTERPOOLMANAGERPROVIDER INTERFACE

Specified by:
getSystemFilterImage in interface ISubSystemConfigurationAdapter

getSystemFilterPoolImage

public 
ImageDescriptor getSystemFilterPoolImage(
ISystemFilterPoolReference filterPoolRef)
Supply the image to be used for filter pool references. This implementation just gets the referenced filter pool and calls the method getSystemFilterPoolImage(ISystemFilterPool) on it. Override this method to provide custom images for filter pool references.

Specified by:
getSystemFilterPoolImage in interface ISubSystemConfigurationAdapter

getSystemFilterImage

public 
ImageDescriptor getSystemFilterImage(
ISystemFilterReference filterRef)
Supply the image to be used for filter references. This implementation just gets the referenced filter and calls the method getSystemFilterImage(ISystemFile) on it. Override this method to provide custom images for filter references.

Specified by:
getSystemFilterImage in interface ISubSystemConfigurationAdapter

getSystemFilterStringImage

public 
ImageDescriptor getSystemFilterStringImage(
ISystemFilterString filterString)
Description copied from interface: ISubSystemConfigurationAdapter
Supply the image to be used for the given filter string, within actions. REQUIRED BY SYSTEMFILTERPOOLMANAGERPROVIDER INTERFACE

Specified by:
getSystemFilterStringImage in interface ISubSystemConfigurationAdapter

getSystemFilterStringImage

public 
ImageDescriptor getSystemFilterStringImage(
String filterStringString)
Description copied from interface: ISubSystemConfigurationAdapter
Supply the image to be used for the given filter string string, within actions. REQUIRED BY SYSTEMFILTERPOOLMANAGERPROVIDER INTERFACE

Specified by:
getSystemFilterStringImage in interface ISubSystemConfigurationAdapter

getFilterPoolActions

public 
IAction[] getFilterPoolActions(
SystemMenuManager menu,
                                      
IStructuredSelection selection,
                                      
Shell shell,
                                      
String menuGroup,
                                      
ISubSystemConfiguration config,
                                      
ISystemFilterPool selectedPool)
Returns a list of actions for the popup menu when user right clicks on a filter pool object within a subsystem of this subsystem configuration. Only supported and used by subsystems that support filters.

YOU DO NOT NEED TO OVERRIDE THIS METHOD.

Most actions are handled in this base, except if you have your own action for creating a new filter. In this case, override getNewFilterAction()

Specified by:
getFilterPoolActions in interface ISubSystemConfigurationAdapter
Parameters:
selectedPool - the currently selected pool
shell - parent shell of viewer where the popup menu is being constructed

getNewFilterPoolFilterActions

protected 
IAction[] getNewFilterPoolFilterActions(
SystemMenuManager menu,
                                                  
IStructuredSelection selection,
                                                  
Shell shell,
                                                  
String menuGroup,
                                                  
ISubSystemConfiguration config,
                                                  
ISystemFilterPool selectedPool)
Overridable method to return the actions for creating a new filter in a filter pool. By default returns one action created by calling getNewFilterPoolFilterAction(ISubSystemConfiguration, ISystemFilterPool, Shell).

If you have multiple actions for creating new filters, override this.

If you have only a single action for creating new filters, override getNewFilterPoolFilterAction (without the 's').

Parameters:
selectedPool - the currently selected pool
shell - parent shell of viewer where the popup menu is being constructed

getNewFilterPoolFilterAction

protected 
IAction getNewFilterPoolFilterAction(
ISubSystemConfiguration config,
                                               
ISystemFilterPool selectedPool,
                                               
Shell shell)
Overridable method to return the single action for creating a new filter in a filter pool. By default returns a default supplied action for this.

If you have multiple actions for creating new filters, override getNewFilterPoolFilterActions (note the 's').

If you have only a single action for creating new filters, override this.

Parameters:
selectedPool - the currently selected pool
shell - parent shell of viewer where the popup menu is being constructed

getNewNestedFilterAction

protected 
IAction getNewNestedFilterAction(
ISubSystemConfiguration config,
                                           
ISystemFilter selectedFilter,
                                           
Shell shell)
Overridable method to return the action for creating a new nested filter inside another filter. By default returns getNewFilterPoolFilterAction(selectedFilter.getParentFilterPool(),shell).

Parameters:
selectedFilter - the currently selected filter
shell - parent shell of viewer where the popup menu is being constructed

getChangeFilterAction

protected 
IAction getChangeFilterAction(
ISubSystemConfiguration config,
                                        
ISystemFilter selectedFilter,
                                        
Shell shell)
Overridable method to return the action for changing an existing filter. By default returns new SystemChangeFilterAction, unless the filter's isSingleFilterStringOnly() returns true, in which case null is returned.

Parameters:
selectedFilter - the currently selected filter
shell - parent shell of viewer where the popup menu is being constructed

customizeChangeFilterPropertyPage

public void customizeChangeFilterPropertyPage(
ISubSystemConfiguration config,
                                              
SystemChangeFilterPropertyPage page,
                                              
ISystemFilter selectedFilter,
                                              
Shell shell)
In addition to a change filter action, we now also support the same functionality via a Properties page for filters. When this page is activated, this method is called to enable customization of the page, given the selected filter.

By default, this method will call getChangeFilterAction(ISubSystemConfiguration, ISystemFilter, Shell) to get your change filter action, and will configure the given page from the dialog created by your change filter action.

If your filter uses its own Change Filter dialog, versus subclassing or configuring SystemChangeFilterDialog you will have to override this method and specify the following information for the supplied page (via its setters):

Specified by:
customizeChangeFilterPropertyPage in interface ISubSystemConfigurationAdapter

customizeFilterStringPropertyPage

public void customizeFilterStringPropertyPage(
ISubSystemConfiguration config,
                                              
SystemFilterStringPropertyPage page,
                                              
ISystemFilterString selectedFilterString,
                                              
Shell shell)
In addition to a change filter action, we now also support the same functionality via a Properties page for filter strings, in the Team View. When this page is activated, this method is called to enable customization of the page, given the selected filter string.

By default, this method will call getChangeFilterAction(ISubSystemConfiguration, ISystemFilter, Shell) to get your change filter action, and will configure the given page from the dialog created by your change filter action.

If your filter uses its own Change Filter dialog, versus subclassing or configuring SystemChangeFilterDialog you will have to override this method and specify the following information for the supplied page (via its setters):

Specified by:
customizeFilterStringPropertyPage in interface ISubSystemConfigurationAdapter

getFilterPoolReferenceActions

public 
IAction[] getFilterPoolReferenceActions(
SystemMenuManager menu,
                                               
IStructuredSelection selection,
                                               
Shell shell,
                                               
String menuGroup,
                                               
ISubSystemConfiguration config,
                                               
ISystemFilterPoolReference selectedPoolReference)
Returns a list of actions for the popup menu when user right clicks on a filter pool reference object within a subsystem of this subsystem configuration. Note, these are added to the list returned by getFilterPoolActions(). Only supported by subsystems that support filters.

Specified by:
getFilterPoolReferenceActions in interface ISubSystemConfigurationAdapter
Parameters:
selectedPoolReference - the currently selected pool reference
shell - parent shell of viewer where the popup menu is being constructed

getRemoveFilterPoolReferenceAction

protected 
IAction getRemoveFilterPoolReferenceAction(
ISubSystemConfiguration config,
                                                     
ISystemFilterPool selectedPool,
                                                     
Shell shell)
Overridable method to return the action for removing a filter pool reference. By default returns new SystemRemoveFilterPoolReferenceAction.

Parameters:
selectedPool - the currently selected pool
shell - parent shell of viewer where the popup menu is being constructed

createFilterByPrompting

public 
ISystemFilter createFilterByPrompting(
ISubSystemConfiguration config,
                                             
ISystemFilterReference referenceToPromptableFilter,
                                             
Shell shell)
                                      throws 
Exception
Prompt the user to create a new filter as a result of the user expanding a promptable filter.

This base implementation prompts using the generic filter prompt. You should override this but copy this code to use as a base/example how to do this.

Specified by:
createFilterByPrompting in interface ISubSystemConfigurationAdapter
Returns:
the filter created by the user or null if they cancelled the prompting
Throws:
Exception

getFilterActions

public 
IAction[] getFilterActions(
SystemMenuManager menu,
                                  
IStructuredSelection selection,
                                  
Shell shell,
                                  
String menuGroup,
                                  
ISubSystemConfiguration config,
                                  
ISystemFilter selectedFilter)
Returns a list of actions for the popup menu when user right clicks on a filter object.

Only supported and used by subsystems that support filters.

YOU DO NOT NEED TO OVERRIDE THIS METHOD.

Most actions are handled in this base, except if you have your own action for creating a new nested filter. In this case, override getNewFilterAction()

Specified by:
getFilterActions in interface ISubSystemConfigurationAdapter

getAdditionalFilterActions

protected 
Vector getAdditionalFilterActions(
ISubSystemConfiguration config,
                                            
ISystemFilter selectedFilter,
                                            
Shell shell)
Overridable entry for child classes to contribute filter actions beyond the default supplied actions.

By default, this returns null.

Returns:
Vector of IAction objects.
See Also:
getFilterActions(SystemMenuManager, IStructuredSelection, Shell, String, ISubSystemConfiguration, ISystemFilter)

getFilterReferenceActions

public 
IAction[] getFilterReferenceActions(
SystemMenuManager menu,
                                           
IStructuredSelection selection,
                                           
Shell shell,
                                           
String menuGroup,
                                           
ISubSystemConfiguration config,
                                           
ISystemFilterReference selectedFilterRef)
Returns a list of actions for the popup menu when user right clicks on a filter reference object within a subsystem of this subsystem configuration. Only supported and used by subsystems that support filters.

YOU DO NOT NEED TO OVERRIDE THIS METHOD.

Most actions are handled in this base, except if you have your own action for creating a new filter. In this case, override getNewFilterAction()

Specified by:
getFilterReferenceActions in interface ISubSystemConfigurationAdapter
Parameters:
selectedFilterRef - the currently selected filter reference
shell - parent shell of viewer where the popup menu is being constructed

getServerLauncherForm

public 
IServerLauncherForm getServerLauncherForm(
ISubSystemConfiguration config,
                                                 
Shell shell,
                                                 
ISystemMessageLine msgLine)
Return the form used in the property page, etc for this server launcher. Only called if ISubSystemConfiguration.supportsServerLaunchProperties(org.eclipse.rse.core.model.IHost) returns true.

Override if appropriate.

Specified by:
getServerLauncherForm in interface ISubSystemConfigurationAdapter
Returns:
the UI form for the server launcher.

getPasswordValidator

public 
ISystemValidator getPasswordValidator(
ISubSystemConfiguration configuration)
Return the validator for the password which is prompted for at runtime. Returns null by default.

Specified by:
getPasswordValidator in interface ISubSystemConfigurationAdapter

getPortValidator

public 
ISystemValidator getPortValidator(
ISubSystemConfiguration configuration)
Return the validator for the port. A default is supplied. This must be castable to ICellEditorValidator for the property sheet support.

Specified by:
getPortValidator in interface ISubSystemConfigurationAdapter

getPropertyPage

public 
PropertyPage getPropertyPage(
ISubSystem subsystem,
                                    
Composite parent)
Description copied from interface: ISubSystemConfigurationAdapter
Return the single property page to show in the tabbed notebook for the for SubSystem property of the parent Connection. Return null if no page is to be contributed for this. You are limited to a single page, so you may have to compress. It is recommended you prompt for the port if applicable since the common base subsystem property page is not shown To help with this you can use the SystemPortPrompt widget.

Specified by:
getPropertyPage in interface ISubSystemConfigurationAdapter

getUserIdValidator

public 
ISystemValidator getUserIdValidator(
ISubSystemConfiguration config)
Description copied from interface: ISubSystemConfigurationAdapter
Return the validator for the userId. A default is supplied. Note this is only used for the subsystem's properties, so will not be used by the connection's default. Thus, is only of limited value.

This must be castable to ICellEditorValidator for the property sheet support.

Specified by:
getUserIdValidator in interface ISubSystemConfigurationAdapter

applyViewFilters

public 
Object[] applyViewFilters(
IContextObject parent,
                                 
Object[] children)
The default implementation does not filter and simply returns the children passed in. Subclasses should override if they want to filter objects.

Specified by:
applyViewFilters in interface ISubSystemConfigurationAdapter
Parameters:
parent - the parent context.
children - the children to filter.
Returns:
the children after filtering.

RSE
Release 3.0

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

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire