|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.rse.ui.view.SubSystemConfigurationAdapter
public class SubSystemConfigurationAdapter
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 |
---|
protected Hashtable imageTable
Constructor Detail |
---|
public SubSystemConfigurationAdapter()
Method Detail |
---|
public void addCommonRemoteActions(ISubSystemConfiguration config, SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystem subsystem)
No need to override.
addCommonRemoteActions
in interface ISubSystemConfigurationAdapter
menu
- 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 selectionconfig
- The subsystem configuration to work onpublic org.eclipse.rse.ui.wizards.newconnection.ISystemNewConnectionWizardPage[] getNewConnectionWizardPages(ISubSystemConfiguration config, IWizard wizard)
Some details:
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.
AbstractSystemNewConnectionWizardPage
for your wizard page class.
getNewConnectionWizardPages
in interface ISubSystemConfigurationAdapter
public ISystemSubSystemPropertyPageCoreForm getSubSystemPropertyPageCoreFrom(ISubSystemConfiguration config, ISystemMessageLine msgLine, Object caller)
ISubSystemConfigurationAdapter
getSubSystemPropertyPageCoreFrom
in interface ISubSystemConfigurationAdapter
public ImageDescriptor getImage(ISubSystemConfiguration config)
ISubSystemConfigurationAdapter
getImage
in interface ISubSystemConfigurationAdapter
config
- the subsystem configuration
public Image getGraphicsImage(ISubSystemConfiguration config)
ISubSystemConfigurationAdapter
getGraphicsImage
in interface ISubSystemConfigurationAdapter
config
- the subsystem configuration
public ImageDescriptor getLiveImage(ISubSystemConfiguration config)
ISubSystemConfigurationAdapter
getLiveImage
in interface ISubSystemConfigurationAdapter
config
- the subsystem configuration
public Image getGraphicsLiveImage(ISubSystemConfiguration config)
ISubSystemConfigurationAdapter
getGraphicsLiveImage
in interface ISubSystemConfigurationAdapter
config
- the subsystem configuration
public IAction[] getSubSystemActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISubSystem selectedSubSystem)
Override if additional actions needs to be contributed.
getSubSystemActions
in interface ISubSystemConfigurationAdapter
selectedSubSystem
- the currently selected subsystemshell
- The Shell of the view where this action was launched from
getSubSystemNewFilterPoolActions(SystemMenuManager, IStructuredSelection, Shell, String, ISubSystemConfiguration, ISubSystem)
protected void addConnectOrDisconnectAction(Vector actions, Shell shell, ISubSystem selectedSS)
actions
- The list of child actions. Add the connect/disconnect action to this vector is applicable.shell
- The shell.selectedSS
- The selected subsystem.public 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
configureNewFilterAction
in interface ISystemNewFilterActionConfigurator
configureNewFilterAction
in interface ISubSystemConfigurationAdapter
newFilterAction
- - the action to be configuredcallerData
- - context data that you supplied when registering this callbackpublic ISystemFilterPool getDefaultSystemFilterPool(ISubSystemConfiguration config, ISystemProfile profile)
protected ISystemFilterPoolWrapperInformation getNewFilterWizardPoolWrapperInformation()
protected IAction[] getSubSystemNewFilterPoolActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISubSystem selectedSubSystem)
selectedSubSystem
- the currently selected subsystemshell
- The Shell of the view where this action was launched from
public ImageDescriptor getSystemFilterPoolManagerImage()
getSystemFilterPoolManagerImage
in interface ISubSystemConfigurationAdapter
public ImageDescriptor getSystemFilterPoolImage(ISystemFilterPool filterPool)
getSystemFilterPoolImage
in interface ISubSystemConfigurationAdapter
public ImageDescriptor getSystemFilterImage(ISystemFilter filter)
getSystemFilterImage
in interface ISubSystemConfigurationAdapter
public ImageDescriptor getSystemFilterPoolImage(ISystemFilterPoolReference filterPoolRef)
getSystemFilterPoolImage
in interface ISubSystemConfigurationAdapter
public ImageDescriptor getSystemFilterImage(ISystemFilterReference filterRef)
getSystemFilterImage
in interface ISubSystemConfigurationAdapter
public ImageDescriptor getSystemFilterStringImage(ISystemFilterString filterString)
ISubSystemConfigurationAdapter
getSystemFilterStringImage
in interface ISubSystemConfigurationAdapter
public ImageDescriptor getSystemFilterStringImage(String filterStringString)
ISubSystemConfigurationAdapter
getSystemFilterStringImage
in interface ISubSystemConfigurationAdapter
public IAction[] getFilterPoolActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterPool selectedPool)
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()
getFilterPoolActions
in interface ISubSystemConfigurationAdapter
selectedPool
- the currently selected poolshell
- parent shell of viewer where the popup menu is being constructedprotected IAction[] getNewFilterPoolFilterActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterPool selectedPool)
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').
selectedPool
- the currently selected poolshell
- parent shell of viewer where the popup menu is being constructedprotected IAction getNewFilterPoolFilterAction(ISubSystemConfiguration config, ISystemFilterPool selectedPool, Shell shell)
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.
selectedPool
- the currently selected poolshell
- parent shell of viewer where the popup menu is being constructedprotected IAction getNewNestedFilterAction(ISubSystemConfiguration config, ISystemFilter selectedFilter, Shell shell)
selectedFilter
- the currently selected filtershell
- parent shell of viewer where the popup menu is being constructedprotected IAction getChangeFilterAction(ISubSystemConfiguration config, ISystemFilter selectedFilter, Shell shell)
selectedFilter
- the currently selected filtershell
- parent shell of viewer where the popup menu is being constructedpublic void customizeChangeFilterPropertyPage(ISubSystemConfiguration config, SystemChangeFilterPropertyPage page, ISystemFilter selectedFilter, Shell shell)
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):
SystemChangeFilterPropertyPage.setDuplicateFilterStringErrorMessage(org.eclipse.rse.services.clientserver.messages.SystemMessage)
SystemChangeFilterPropertyPage.setFilterStringEditPane(org.eclipse.rse.ui.filters.SystemFilterStringEditPane)
SystemChangeFilterPropertyPage.setFilterStringValidator(org.eclipse.rse.ui.validators.ISystemValidator)
SystemChangeFilterPropertyPage.setListLabel(String, String)
SystemChangeFilterPropertyPage.setParentPoolPromptLabel(String, String)
SystemChangeFilterPropertyPage.setNamePromptLabel(String, String)
SystemChangeFilterPropertyPage.setNewListItemText(String)
SystemChangeFilterPropertyPage.setDuplicateFilterStringErrorMessage(org.eclipse.rse.services.clientserver.messages.SystemMessage)
SystemChangeFilterPropertyPage.setEditable(boolean)
SystemChangeFilterPropertyPage.setSupportsMultipleStrings(boolean)
DialogPage.setDescription(String)
customizeChangeFilterPropertyPage
in interface ISubSystemConfigurationAdapter
public void customizeFilterStringPropertyPage(ISubSystemConfiguration config, SystemFilterStringPropertyPage page, ISystemFilterString selectedFilterString, Shell shell)
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):
SystemFilterStringPropertyPage.setDuplicateFilterStringErrorMessage(org.eclipse.rse.services.clientserver.messages.SystemMessage)
SystemFilterStringPropertyPage.setFilterStringEditPane(org.eclipse.rse.ui.filters.SystemFilterStringEditPane)
SystemFilterStringPropertyPage.setFilterStringValidator(org.eclipse.rse.ui.validators.ISystemValidator)
SystemFilterStringPropertyPage.setDuplicateFilterStringErrorMessage(org.eclipse.rse.services.clientserver.messages.SystemMessage)
SystemFilterStringPropertyPage.setEditable(boolean)
DialogPage.setDescription(String)
customizeFilterStringPropertyPage
in interface ISubSystemConfigurationAdapter
public IAction[] getFilterPoolReferenceActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterPoolReference selectedPoolReference)
getFilterPoolReferenceActions
in interface ISubSystemConfigurationAdapter
selectedPoolReference
- the currently selected pool referenceshell
- parent shell of viewer where the popup menu is being constructedprotected IAction getRemoveFilterPoolReferenceAction(ISubSystemConfiguration config, ISystemFilterPool selectedPool, Shell shell)
selectedPool
- the currently selected poolshell
- parent shell of viewer where the popup menu is being constructedpublic ISystemFilter createFilterByPrompting(ISubSystemConfiguration config, ISystemFilterReference referenceToPromptableFilter, Shell shell) throws Exception
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.
createFilterByPrompting
in interface ISubSystemConfigurationAdapter
Exception
public IAction[] getFilterActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilter selectedFilter)
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()
getFilterActions
in interface ISubSystemConfigurationAdapter
protected Vector getAdditionalFilterActions(ISubSystemConfiguration config, ISystemFilter selectedFilter, Shell shell)
By default, this returns null.
getFilterActions(SystemMenuManager, IStructuredSelection, Shell, String, ISubSystemConfiguration, ISystemFilter)
public IAction[] getFilterReferenceActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystemConfiguration config, ISystemFilterReference selectedFilterRef)
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()
getFilterReferenceActions
in interface ISubSystemConfigurationAdapter
selectedFilterRef
- the currently selected filter referenceshell
- parent shell of viewer where the popup menu is being constructedpublic IServerLauncherForm getServerLauncherForm(ISubSystemConfiguration config, Shell shell, ISystemMessageLine msgLine)
ISubSystemConfiguration.supportsServerLaunchProperties(org.eclipse.rse.core.model.IHost)
returns true.
Override if appropriate.
getServerLauncherForm
in interface ISubSystemConfigurationAdapter
public ISystemValidator getPasswordValidator(ISubSystemConfiguration configuration)
getPasswordValidator
in interface ISubSystemConfigurationAdapter
public ISystemValidator getPortValidator(ISubSystemConfiguration configuration)
getPortValidator
in interface ISubSystemConfigurationAdapter
public PropertyPage getPropertyPage(ISubSystem subsystem, Composite parent)
ISubSystemConfigurationAdapter
getPropertyPage
in interface ISubSystemConfigurationAdapter
public ISystemValidator getUserIdValidator(ISubSystemConfiguration config)
ISubSystemConfigurationAdapter
This must be castable to ICellEditorValidator for the property sheet support.
getUserIdValidator
in interface ISubSystemConfigurationAdapter
public Object[] applyViewFilters(IContextObject parent, Object[] children)
applyViewFilters
in interface ISubSystemConfigurationAdapter
parent
- the parent context.children
- the children to filter.
|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |