Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.actions
Interface ISystemAction

All Known Subinterfaces:
ISystemDialogAction, ISystemWizardAction
All Known Implementing Classes:
SystemBaseAction, SystemBaseDialogAction, SystemBaseWizardAction, SystemFilterNewFilterPoolAction

public interface ISystemAction

Suggested interface for actions in popup menus of the remote systems explorer view. While suggested, it is not required to implement this interface.

See Also:
SystemBaseAction

Field Summary
static String copyright
           
 
Method Summary
 void allowOnMultipleSelection(boolean allow)
          Is this action to be enabled or disabled when multiple items are selected.
 String getContextMenuGroup()
          Get the context menu group this action is to go into, for popup menus.
 String getHelpContextId()
          Get the help id for this action
 IStructuredSelection getSelection()
          Retrieve selection as set by selectionChanged() or setSelection()
 Shell getShell()
          Convenience method to get shell of parent window, as set via setShell.
 Viewer getViewer()
          Get the Viewer that called this action.
 boolean isDummy()
          Return if true if this is a dummy action
 boolean isSelectionSensitive()
          Return whether this action is selection-sensitive.
 void setContextMenuGroup(String group)
          Set the context menu group this action is to go into, for popup menus.
 void setHelp(String id)
          Set the help id for the action
 void setInputs(Shell shell, Viewer v, ISelection selection)
          An optimization for performance reasons that allows all inputs to be set in one call
 void setSelection(ISelection selection)
          Sometimes we can't call selectionChanged() because we are not a selection provider.
 void setSelectionSensitive(boolean sensitive)
          Specify whether this action is selection-sensitive.
 void setShell(Shell shell)
          Set shell of parent window.
 void setViewer(Viewer v)
          Set the Viewer that called this action.
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

setHelp

public void setHelp(String id)
Set the help id for the action


setContextMenuGroup

public void setContextMenuGroup(String group)
Set the context menu group this action is to go into, for popup menus. If not set, someone else will make this decision.


allowOnMultipleSelection

public void allowOnMultipleSelection(boolean allow)
Is this action to be enabled or disabled when multiple items are selected.


setSelectionSensitive

public void setSelectionSensitive(boolean sensitive)
Specify whether this action is selection-sensitive. The default is true. This means the enabled state is tested and set when the selection is set.


setShell

public void setShell(Shell shell)
Set shell of parent window. Remote systems explorer will call this.


setViewer

public void setViewer(Viewer v)
Set the Viewer that called this action. It is good practice for viewers to call this so actions can directly access them if needed.


setSelection

public void setSelection(ISelection selection)
Sometimes we can't call selectionChanged() because we are not a selection provider. In this case, use this to set the selection.


setInputs

public void setInputs(Shell shell,
                      Viewer v,
                      ISelection selection)
An optimization for performance reasons that allows all inputs to be set in one call


getHelpContextId

public String getHelpContextId()
Get the help id for this action


getShell

public Shell getShell()
Convenience method to get shell of parent window, as set via setShell.


getViewer

public Viewer getViewer()
Get the Viewer that called this action. Not guaranteed to be set, depends if that viewer called setViewer or not. SystemView does.


getSelection

public IStructuredSelection getSelection()
Retrieve selection as set by selectionChanged() or setSelection()


getContextMenuGroup

public String getContextMenuGroup()
Get the context menu group this action is to go into, for popup menus. By default is null, meaning there is no recommendation


isSelectionSensitive

public boolean isSelectionSensitive()
Return whether this action is selection-sensitive. The default is true. This means the enabled state is tested and set when the selection is set.


isDummy

public boolean isDummy()
Return if true if this is a dummy action


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.