|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISubSystemConfigurationAdapter
Defines the interface that must be implemented for adapters of for subsystem configurations. This adapter is used when creating wizard pages for new connections.
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. |
Object[] |
applyViewFilters(IContextObject parent,
Object[] children)
Filters an array of children and returns the results. |
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. |
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 Connection Wizard if the user selects a system type that this subsystem configuration supports. |
ISystemValidator |
getPasswordValidator(ISubSystemConfiguration confi)
Return the validator for the password which is prompted for at runtime. |
ISystemValidator |
getPortValidator(ISubSystemConfiguration confi)
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. |
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. |
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 filter)
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 filterPool)
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. |
Method Detail |
---|
void configureNewFilterAction(ISubSystemConfiguration config, SystemNewFilterAction newFilterAction, Object callerData)
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
org.eclipse.rse.ui.wizards.newconnection.ISystemNewConnectionWizardPage[] getNewConnectionWizardPages(ISubSystemConfiguration config, IWizard wizard)
Some details:
ISubSystemConfiguration.createSubSystem(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.
AbstractSystemNewConnectionWizardPage
for your wizard page class.
void addCommonRemoteActions(ISubSystemConfiguration config, SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystem subsystem)
config
- The subsystem configuration to work onmenu
- The menu to contribute actions toselection
- 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 selectionIAction[] getFilterPoolActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterPool selectedPool)
IAction[] getFilterPoolReferenceActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterPoolReference selectedPoolReference)
Only supported by subsystems that support filters.
IAction[] getFilterActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilter selectedFilter)
Only supported and used by subsystems that support filters.
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()
void customizeChangeFilterPropertyPage(ISubSystemConfiguration config, SystemChangeFilterPropertyPage page, ISystemFilter selectedFilter, Shell shell)
void customizeFilterStringPropertyPage(ISubSystemConfiguration config, SystemFilterStringPropertyPage page, ISystemFilterString selectedFilterString, Shell shell)
ISystemFilter createFilterByPrompting(ISubSystemConfiguration config, ISystemFilterReference referenceToPromptableFilter, Shell shell) throws Exception
Exception
IAction[] getFilterReferenceActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterReference selectedFilterRef)
Most actions are handled in this base, except if you have your own action for
creating a new filter. In this case, override getNewFilterAction()
To add additional actions, override getFilterReferenceActions(SystemMenuManager, IStructuredSelection, Shell, String, ISubSystemConfiguration, ISystemFilterReference)
.
selectedFilterRef
- the currently selected filter referenceshell
- parent shell of viewer where the popup menu is being constructedIAction[] getSubSystemActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISubSystem selectedSubSystem)
IServerLauncherForm getServerLauncherForm(ISubSystemConfiguration config, Shell shell, ISystemMessageLine msgLine)
ISubSystemConfiguration.supportsServerLaunchProperties(IHost)
returns true.
ISystemSubSystemPropertyPageCoreForm getSubSystemPropertyPageCoreFrom(ISubSystemConfiguration config, ISystemMessageLine msgLine, Object caller)
ImageDescriptor getImage(ISubSystemConfiguration config)
config
- the subsystem configuration
Image getGraphicsImage(ISubSystemConfiguration config)
config
- the subsystem configuration
ImageDescriptor getLiveImage(ISubSystemConfiguration config)
config
- the subsystem configuration
Image getGraphicsLiveImage(ISubSystemConfiguration config)
config
- the subsystem configuration
ImageDescriptor getSystemFilterPoolManagerImage()
ImageDescriptor getSystemFilterPoolImage(ISystemFilterPool filterPool)
ImageDescriptor getSystemFilterImage(ISystemFilter filter)
ImageDescriptor getSystemFilterPoolImage(ISystemFilterPoolReference filterPool)
ImageDescriptor getSystemFilterImage(ISystemFilterReference filter)
ImageDescriptor getSystemFilterStringImage(ISystemFilterString filterString)
ImageDescriptor getSystemFilterStringImage(String filterStringString)
PropertyPage getPropertyPage(ISubSystem subsystem, Composite parent)
ISystemValidator getUserIdValidator(ISubSystemConfiguration config)
This must be castable to ICellEditorValidator for the property sheet support.
ISystemValidator getPasswordValidator(ISubSystemConfiguration confi)
ISystemValidator getPortValidator(ISubSystemConfiguration confi)
Object[] applyViewFilters(IContextObject parent, Object[] children)
parent
- the parent context.children
- the children to filter.
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |