iSeries Remote Systems
v6.0.0

com.ibm.etools.iseries.core.ui.actions
Class ISeriesSystemBaseAction

java.lang.Object
  extended byorg.eclipse.jface.action.Action
      extended bycom.ibm.etools.systems.core.ui.actions.SystemBaseAction
          extended bycom.ibm.etools.iseries.core.ui.actions.ISeriesSystemBaseAction
All Implemented Interfaces:
IAction, ISelectionChangedListener, com.ibm.etools.systems.core.ui.actions.ISystemAction
Direct Known Subclasses:
ISeriesAbstractLiblAction, ISeriesCacheDatabaseFileDescAction, ISeriesChangeMessageDescriptionAction, ISeriesChangeObjAction, ISeriesChangePasswordAction, ISeriesCompileModuleAction, ISeriesCompileSingleProgramAction, ISeriesCompileSingleServiceProgramAction, ISeriesDataTableView.ISeriesDataTableViewAddRecAction, ISeriesDataTableViewGoAction, ISeriesEditorRPGIndentViewPart.PrintAction, ISeriesEditSrcPhysicalFileMemberAction, ISeriesMonitorJobAction, ISeriesNewMessageDescriptionAction, ISeriesOpenMbrWithLocalAction, ISeriesOpenMemberAction, ISeriesPrintTableViewAction, ISeriesRefreshAction, ISeriesRunRemoteCommandAction, ISeriesRunRemoteCommandOnSubsystemAction, ISeriesRunRemoteQSYSProgramAction, ISeriesSaveRestoreAction, ISeriesSearchResultViewPDMAction, ISeriesShowCmdTableViewAction, ISeriesShowDataTableViewAction, ISeriesShowEventsFileAction, ISeriesShowFldTableViewAction, ISeriesShowMbrTableViewAction, ISeriesShowMessageLogAction, ISeriesShowObjTableViewAction, ISeriesTableViewDataDeleteAction, ISeriesTableViewDeleteAction, ISeriesTableViewGoAction, ISeriesTableViewHistoryAction, ISeriesTableViewLockAction, ISeriesTableViewNewAction, ISeriesTableViewPDMAction, ISeriesTableViewSelectAllAction, ISeriesTableViewShowAllAction, ISeriesTableViewShowColumnsAction, ISeriesTableViewShowPreferencesAction, ISeriesTableViewWorkWithAction, ISeriesToggleTableViewBasicAction, ISeriesToggleTableViewExtraAction, ISeriesUploadConflictAction, ISeriesVerifyConnectionAction, ISeriesVerifySourceAction

public abstract class ISeriesSystemBaseAction
extends com.ibm.etools.systems.core.ui.actions.SystemBaseAction

Base dialog class for iSeries dialog actions. This adds support to disable the action if user has chosen to work offline. It also adds a couple helper methods for dataelements and ISeriesConnections


Field Summary
static String copyright
           
 
Fields inherited from class com.ibm.etools.systems.core.ui.actions.SystemBaseAction
allowOnMultipleSelection, arrowCursor, helpId, selectionSensitive, shell, sSelection, traceSelections, traceTarget, viewer, waitCursor
 
Fields inherited from interface org.eclipse.jface.action.IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
ISeriesSystemBaseAction(ResourceBundle rb, String prefix, ImageDescriptor image, Shell parent)
          Constructor for ISeriesSystemBaseAction given a resource bundle from which the label, tooltip and description can be retrieved.
ISeriesSystemBaseAction(ResourceBundle rb, String prefix, Shell parent)
          Used for actions with no image icon.
ISeriesSystemBaseAction(String text, ImageDescriptor image, Shell parent)
          Constructor for ISeriesSystemBaseAction when translated label is known.
ISeriesSystemBaseAction(String text, Shell parent)
          Used for actions with no image icon.
ISeriesSystemBaseAction(String text, String tooltip, ImageDescriptor image, Shell parent)
          Constructor for ISeriesSystemBaseAction when translated label and tooltip are known.
ISeriesSystemBaseAction(String text, String tooltip, Shell parent)
          Used for actions with no image icon.
ISeriesSystemBaseAction(String text, String tooltip, String description, ImageDescriptor image, Shell parent)
          Constructor for ISeriesSystemBaseAction when translated label and tooltip and description are all known.
ISeriesSystemBaseAction(String text, String tooltip, String description, Shell parent)
          Used for actions with no image icon.
 
Method Summary
static com.ibm.etools.systems.dstore.core.model.DataElement getDataElement(Object element)
          Get the DataElement given the input.
 ISeriesConnection getISeriesConnection(Object element)
          Returns the ISeriesConnection from which this object originated
 void isAvailableOffline(boolean availableOffline)
          If this is one of those rare actions that is to be made available in offline mode, then call this in during or immediately after constructing to state that.
 boolean updateSelection(IStructuredSelection selection)
           
 
Methods inherited from class com.ibm.etools.systems.core.ui.actions.SystemBaseAction
allowOnMultipleSelection, checkObjectType, getAdapter, getContextMenuGroup, getCurrentTreeView, getDescription, getFirstSelection, getHelpContextId, getLabel, getNextSelection, getRemoteAdapter, getSelection, getSelectionProvider, getShell, getShell, getString, getStringOrNull, getSystemConnection, getToolTip, getViewer, isDummy, isEnabled, isSelectionSensitive, issueTraceMessage, run, selectionChanged, setAvailableOffline, setBusyCursor, setContextMenuGroup, setDisplayCursor, setDisplayCursor, setHelp, setInputs, setSelection, setSelectionProvider, setSelectionSensitive, setShell, setSystemConnection, setTracing, setTracing, setViewer
 
Methods inherited from class org.eclipse.jface.action.Action
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, notifyResult, removeAcceleratorText, removeMnemonics, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.action.IAction
addPropertyChangeListener, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 

Field Detail

copyright

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

ISeriesSystemBaseAction

public ISeriesSystemBaseAction(String text,
                               ImageDescriptor image,
                               Shell parent)
Constructor for ISeriesSystemBaseAction when translated label is known. You must separately call setToolTipText and setDescription to enable these if desired.

Parameters:
text - string to display in menu or toolbar
image - icon to display in menu or toolbar. Can be null.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

ISeriesSystemBaseAction

public ISeriesSystemBaseAction(String text,
                               String tooltip,
                               ImageDescriptor image,
                               Shell parent)
Constructor for ISeriesSystemBaseAction when translated label and tooltip are known. You must separately call setDescription to enable this if desired.

Parameters:
text - string to display in menu or toolbar
tooltip - string to display when user hovers mouse over action.
image - icon to display in menu or toolbar. Can be null.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

ISeriesSystemBaseAction

public ISeriesSystemBaseAction(String text,
                               String tooltip,
                               String description,
                               ImageDescriptor image,
                               Shell parent)
Constructor for ISeriesSystemBaseAction when translated label and tooltip and description are all known.

Parameters:
text - string to display in menu or toolbar
tooltip - string to display when user hovers mouse over action.
description - string displayed in status bar of some displays. Longer than tooltip.
image - icon to display in menu or toolbar. Can be null.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

ISeriesSystemBaseAction

public ISeriesSystemBaseAction(ResourceBundle rb,
                               String prefix,
                               ImageDescriptor image,
                               Shell parent)
Constructor for ISeriesSystemBaseAction given a resource bundle from which the label, tooltip and description can be retrieved.

Parameters:
rb - ResourceBundle that label (+".label"), tip (+".tooltip") and description (+".description") are derived from.
prefix - resource properties prefix that suffixes are added to, to find label, tip and desc.
image - icon to display in menu or toolbar. can be null.

ISeriesSystemBaseAction

public ISeriesSystemBaseAction(String text,
                               Shell parent)
Used for actions with no image icon. Constructor for ISeriesSystemBaseAction when translated label is known. You must separately call setToolTipText and setDescription to enable these if desired.

Parameters:
text - string to display in menu or toolbar
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

ISeriesSystemBaseAction

public ISeriesSystemBaseAction(String text,
                               String tooltip,
                               Shell parent)
Used for actions with no image icon. Constructor for ISeriesSystemBaseAction when translated label and tooltip are known. You must separately call setDescription to enable this if desired.

Parameters:
text - string to display in menu or toolbar
tooltip - string to display when user hovers mouse over action.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

ISeriesSystemBaseAction

public ISeriesSystemBaseAction(String text,
                               String tooltip,
                               String description,
                               Shell parent)
Used for actions with no image icon. Constructor for ISeriesSystemBaseAction when translated label and tooltip and description are all known.

Parameters:
text - string to display in menu or toolbar
tooltip - string to display when user hovers mouse over action.
description - string displayed in status bar of some displays. Longer than tooltip.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

ISeriesSystemBaseAction

public ISeriesSystemBaseAction(ResourceBundle rb,
                               String prefix,
                               Shell parent)
Used for actions with no image icon. Constructor for ISeriesSystemBaseAction given a resource bundle from which the label, tooltip and description can be retrieved.

Parameters:
rb - ResourceBundle that label (+".label"), tip (+".tooltip") and description (+".description") are derived from.
prefix - resource properties prefix that suffixes are added to, to find label, tip and desc.
Method Detail

isAvailableOffline

public void isAvailableOffline(boolean availableOffline)
If this is one of those rare actions that is to be made available in offline mode, then call this in during or immediately after constructing to state that.


updateSelection

public boolean updateSelection(IStructuredSelection selection)

getDataElement

public static com.ibm.etools.systems.dstore.core.model.DataElement getDataElement(Object element)
Get the DataElement given the input. The input is either a DataElement directly, or a ISeriesDataElementWrapper wrapper.


getISeriesConnection

public ISeriesConnection getISeriesConnection(Object element)
Returns the ISeriesConnection from which this object originated


iSeries Remote Systems
v6.0.0

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.